Difference between revisions of "Resource delete"

From Catglobe Wiki
Jump to: navigation, search
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.  
+
=Resource_delete=
 +
&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;- Delete a specific resource.<br>&nbsp;&nbsp;&nbsp;&nbsp;+ User must have administrator right on the resource which will be deleted.<br>&nbsp;&nbsp;&nbsp;&nbsp;+ And user also must have navigation access to that resource.  
 +
 
 +
 
  
 
'''Syntax'''<br> '''&nbsp;'''&nbsp;'''&nbsp;''' Resource_delete(ResourceID);  
 
'''Syntax'''<br> '''&nbsp;'''&nbsp;'''&nbsp;''' Resource_delete(ResourceID);  
  
<br>'''Arguments''' <br>&nbsp;&nbsp; ResourceID: is a number. <br>
 
  
'''Return type'''<br> &nbsp;&nbsp;&nbsp; bool.<br> &nbsp;&nbsp;&nbsp;+ true if deleted and child resources deleted also.  
+
 
 +
'''Arguments''' <br>&nbsp;&nbsp; ResourceID: is a number. It is the resource id of resource.<br>
 +
 
 +
 
 +
 
 +
'''Return type'''<br> &nbsp;&nbsp;&nbsp; Boolean <br> &nbsp;&nbsp; -&nbsp; true if deleted and child resources deleted also.  
 +
 
 +
 
  
 
'''Examples'''  
 
'''Examples'''  
  
bool RDelstatus =Resource_delete(37278397); <br> print(RDelstatus);  
+
bool RDelstatus =Resource_delete(37278397); <br> print(RDelstatus);&nbsp; &nbsp;&nbsp; // result: true<br>
  
 
[[Category:Resource_Functions]]
 
[[Category:Resource_Functions]]

Revision as of 09:24, 9 November 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.


Examples

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