EssShutdownServer

Description

EssShutdownServer() stops the Essbase Agent. This function sends a request to the Essbase Agent (ESSBASE.EXE) to shut itself down. The Agent then goes through its normal shutdown procedure, including committing data, stopping all applications and databases, and logging users off before stopping.

Only users with Supervisor privilege can shut down the Agent.

This function can be called at any time, however, it is normally called to shut down an Agent process which was started in the background. See the Database Administrator's Guide for details.

Syntax

ESS_FUNC_M  EssShutdownServer (hInstance, Server, UserName, Password); 
ESS_HINST_ThInstance
ESS_STR_TServer
ESS_STR_TUserName
ESS_STR_TPassword

Parameters

hInstanceEssbase API instance handle.
ServerNetwork server name string. Specifies the name of the server to shut down.
UserNameUser name string. Specifies the user who is requesting the shutdown.
PasswordPassword string. Specifies the password of the user requesting the shutdown.

Return Value

Possible error conditions resulting from this function include:

Access

This function requires Supervisor privilege.

Example

ESS_FUNC_M 
ESS_ShutdownServer (ESS_HINST_T hInst)
{
   ESS_FUNC_M     sts = ESS_STS_NOERR;
   ESS_STR_T     Server;
   ESS_STR_T     UserName;
   ESS_STR_T     Password;
   
   Server = "Rainbow";
   UserName = "Admin";
   Password = "password";
   sts = EssShutdownServer(hInst, Server,
         UserName, Password);
   return (sts);
}

See Also

EssSetPassword()
EssUnloadApplication()
EssUnloadDatabase()