EssShutdownServer

Stops the Essbase Agent. This function sends a request to the 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 Oracle Essbase Database Administrator's Guide for details.

Syntax

ESS_FUNC_M  EssShutdownServer (hInstance, Server, UserName, Password);

Parameter	Data Type	Description
hInstance	ESS_HINST_T	API instance handle.
Server	ESS_STR_T	Network server name string. Specifies the name of the server to shut down.
UserName	ESS_STR_T	User name string. Specifies the user who is requesting the shutdown.
Password	ESS_STR_T	Password string. Specifies the password of the user requesting the shutdown.

Return Value

Possible error conditions resulting from this function include:

Insufficient privilege for this operation, AD_AMSG_IPO
Incorrect password, AD_AMSG_IPW
User does not exist, AD_AMSG_UNE
Cannot shutdown application, AD_MSGAR_NOSHUTDOWN
Network Error: Unable To Locate In Hosts File, NET_TCP_HOSTS
Network error: Cannot locate server, NET_NP_NOSERVER

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);
}