RenameResource

This function renames a resource.

Syntax

bool renameResource ( string resourceName, string newResourceName, [ string organizationalPath ] )

Required Arguments

• resourceName: The name of resource to rename.
• newResourceName: The name of what the resource should be renamed to.

Optional Arguments

• organizationalPath: If you want to store the new resource inside a category.

Returns

Returns true if the resource has been renamed successfully, false otherwise. This could fail if the resource name already is in use, if a directory already exists with the name you've specified (but this isn't a valid resource) or if the name you specify isn't valid. It could also fail if the disk was full or for other similar reasons. Won't work on a started resource or if the resource is not loaded (not known by MTA (use /refresh))

Example

-- No example yet

Requirements

Minimum server version	1.1.1-9.03316
Minimum client version	n/a

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.1.1-9.03316" />

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