EssRenameApplication
Description
EssRenameApplication() renames an existing application,
either on the client or the server. If the application is running
on the server, it is first stopped.
Syntax
ESS_FUNC_M EssRenameApplication (hCtx, OldName, NewName);
ESS_HCTX_T | hCtx |
ESS_STR_T | OldName |
ESS_STR_T | NewName |
Parameters
hCtx | Essbase API context handle. |
OldName | Name of existing application to rename.
|
NewName | New name of application. Application names can be 8 characters long, and can contain all special characters allowed in DOS file names. No spaces, commas, tabs, slashes, backslashes, or periods are allowed. The use of some special characters is not recommended because they are often used by the operating system (for example, @, $, %, and &).
|
Return Value
None.
Notes
- Renaming a client application renames the local application
directory.
Access
For a server application, the caller must have Application Create/Delete/Edit
privilege (ESS_PRIV_APPCREATE).
Example
ESS_FUNC_M
ESS_RenameApp (ESS_HCTX_T hCtx)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_STR_T OldName;
ESS_STR_T NewName;
OldName = "Sample";
NewName = "Sample2";
sts = EssRenameApplication(hCtx, OldName,
NewName);
return (sts);
}
See Also
EssRenameDatabase()
EssRenameObject()