AclDestroy: Difference between revisions
Jump to navigation
Jump to search
m (→See Also) |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This function destroys the ACL passed. The destroyed ACL will no longer be valid. | ||
==Syntax== | ==Syntax== | ||
Line 11: | Line 11: | ||
===Required Arguments=== | ===Required Arguments=== | ||
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | <!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | ||
*''' | *'''theACL:''' The ACL to destroy | ||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ''true'' if | Returns ''true'' if successfully destroyed and ''false'' if it could not be deleted (ie. it's not valid). | ||
==Example== | ==Example== | ||
Line 28: | Line 22: | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | --TODO | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 08:46, 26 November 2007
This function destroys the ACL passed. The destroyed ACL will no longer be valid.
Syntax
bool aclDestroy ( acl theACL )
Required Arguments
- theACL: The ACL to destroy
Returns
Returns true if successfully destroyed and false if it could not be deleted (ie. it's not valid).
Example
This example does...
--TODO
See Also
- aclCreate
- aclCreateGroup
- aclDestroy
- aclDestroyGroup
- aclGet
- aclGetGroup
- aclGetName
- aclGetRight
- aclGroupAddACL
- aclGroupAddObject
- aclGroupGetName
- aclGroupList
- aclGroupListACL
- aclGroupListObjects
- aclGroupRemoveACL
- aclGroupRemoveObject
- aclList
- aclListRights
- aclReload
- aclRemoveRight
- aclSave
- aclSetRight
- hasObjectPermissionTo
- isObjectInACLGroup