EsbShutdownServer

Stops the Agent.

Syntax

EsbShutdownServer (hInst, Server, User, Password)
ByVal hInst    As Long
ByVal Server   As String
ByVal User     As String
ByVal Password As String

Parameter	Description
hInst	VB API instance handle.
Server	Network server name string. Specifies the name of the server to shut down.
User	User name string. Specifies the user who is requesting the shutdown.
Password	Password string. Specifies the password of the user requesting the shutdown.

Notes

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 Administrator 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.

Return Value

None.

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 administrator privilege.

Example

Declare Function EsbShutdownServer Lib "ESBAPIN" (ByVal hInst As Long, ByVal Server As String, ByVal User As String, ByVal Password As String) As Long 

Sub ESB_ShutdownServer()
   Dim sts As Long
   Dim Server As String
   Dim UserName As String
   Dim Password As String   Server = "Rainbow"
   UserName = "Admin"
   Password = "password"   '******************
   ' Shut down Server
   '******************
   sts = EsbShutdownServer(hInst, Server, UserName, Password) 
End Sub