Difference between revisions of "Resource delete"

From Catglobe Wiki
Jump to: navigation, search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''Resource_delete'''<br>&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;- Delete a resource.<br>&nbsp;&nbsp;&nbsp;&nbsp;+ User must have full access to that resource or error will return false if no access to child resources or problem with deleting.<br>&nbsp;&nbsp;&nbsp;&nbsp;+ And user must have nav access to the right xxx_delete also.
+
{{HelpFiles}}
 +
= Resource_delete =
  
'''Syntax'''<br> '''&nbsp;'''&nbsp;'''&nbsp;''' Resource_delete(ResourceID);
+
Delete a specific resource.
  
<br>'''Arguments''' <br>&nbsp;&nbsp; ResourceID: is a number. <br>
+
*User must have administrator right on the resource which will be deleted.
 +
*And user also must have navigation access to that resource.
  
'''Return type'''<br> &nbsp;&nbsp;&nbsp; bool.<br> &nbsp;&nbsp;&nbsp;+ true if deleted and child resources deleted also.
+
<br>  
  
'''Examples'''
+
=== Syntax  ===
  
bool RDelstatus =Resource_delete(37278397);
+
Resource_delete(ResourceID)  
  
print(RDelstatus);  
+
<br>
 +
 
 +
=== Arguments  ===
 +
 
 +
ResourceID: is a number. It is the resource id of resource.
 +
 
 +
<br>
 +
 
 +
=== Return type  ===
 +
 
 +
Boolean
 +
 
 +
*true if deleted and child resources deleted also.
 +
*false if the resource can not be deleted.
 +
 
 +
<br>
 +
 
 +
=== Examples  ===
 +
 
 +
bool RDelstatus =Resource_delete(37278397); <br> print(RDelstatus);&nbsp; &nbsp;&nbsp; // result: true
  
 
[[Category:Resource_Functions]]
 
[[Category:Resource_Functions]]
 +
__NOTOC__

Latest revision as of 04:51, 14 December 2011

Resource_delete

Delete a specific resource.

  • User must have administrator right on the resource which will be deleted.
  • And user also must have navigation access to that resource.


Syntax

Resource_delete(ResourceID)


Arguments

ResourceID: is a number. It is the resource id of resource.


Return type

Boolean

  • true if deleted and child resources deleted also.
  • false if the resource can not be deleted.


Examples

bool RDelstatus =Resource_delete(37278397);
print(RDelstatus);     // result: true