EssRenameDatabase

Renames an existing database within an application, either on the client or the server. If the database is running on the server, it is first stopped.

Syntax

ESS_FUNC_M  EssRenameDatabase (hCtx, AppName, OldName, NewName); 
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

AppName

ESS_STR_T

Application name.

OldName

ESS_STR_T

Name of existing database to rename.

NewName

ESS_STR_T

New name of database. See Database Name Limits.

Notes

Renaming a client database renames the local database directory.

Return Value

None.

Access

For a server database, the caller must have Database Create/Delete/Edit privilege (ESS_PRIV_DBCREATE).

Example

ESS_FUNC_M 
ESS_RenameDatabase (ESS_HCTX_T hCtx)
{
   ESS_FUNC_M  sts;
   ESS_STR_T  AppName;
   ESS_STR_T  OldName;
   ESS_STR_T  NewName;
   
   AppName = "Sample";
   OldName = "Basic";
   NewName = "Basic2";
   
   sts = EssRenameDatabase(hCtx, AppName, OldName,
         NewName);
   
   return(sts);
}

See Also