RemoveResourceFile: Difference between revisions
Jump to navigation
Jump to search
(New page: {{Server function}} __NOTOC__ tba ==Syntax== <syntaxhighlight lang="lua"> bool removeResourceFile ( resource, name ) </syntaxhighlight> ===Required Arguments=== <!-- List each argument one per line. This shoul...) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Server function}} | {{Server function}} | ||
__NOTOC__ | __NOTOC__ | ||
This function removes a file from the resource. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool removeResourceFile ( resource, | bool removeResourceFile ( resource theResource, string fileName ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===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 --> | ||
*''' | *'''theResource:''': The resource element. | ||
*'''fileName:''': The filename what you wan't to delete. | |||
*''' | |||
===Returns=== | ===Returns=== | ||
Returns ''true'' if file was deleted, otherwise ''false''. | |||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Add example | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Resource_functions}} | {{Resource_functions}} | ||
Revision as of 05:55, 19 June 2009
This function removes a file from the resource.
Syntax
bool removeResourceFile ( resource theResource, string fileName )
Required Arguments
- theResource:: The resource element.
- fileName:: The filename what you wan't to delete.
Returns
Returns true if file was deleted, otherwise false.
Example
Click to collapse [-]
Server-- Add example
See Also
- abortRemoteRequest
- addResourceConfig
- addResourceMap
- call
- callRemote
- copyResource
- createResource
- deleteResource
- fetchRemote
- getRemoteRequestInfo
- getRemoteRequests
- getResourceACLRequests
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceName
- getResourceOrganizationalPath
- getResourceRootElement
- getResources
- getResourceState
- getThisResource
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest