EsbShutdownServer

エージェントを停止します。

構文

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

パラメータ	説明
hInst	VB APIインスタンス・ハンドル。
Server	ネットワーク・サーバー名の文字列。シャットダウンするサーバーの名前を指定します。
User	ユーザー名の文字列。シャットダウンを要求しているユーザーを指定します。
Password	パスワード文字列。シャットダウンを要求しているユーザーのパスワードを指定します。

備考

この関数はエージェント(ESSBASE.EXE)に対して、この関数をシャットダウンするように要求を送信します。エージェントは、データのコミット、すべてのアプリケーションとデータベースの終了、ユーザーのログオフ後の停止など、通常のシャットダウン手順を実行します。
管理者権限を持っているユーザーのみが、エージェントをシャットダウンできます。
この関数はいつでも呼び出せますが、通常はバックグラウンドで起動されたエージェントのシャットダウンのために呼び出します。詳細は、『Oracle Essbaseデータベース管理者ガイド』を参照してください。

戻り値

なし。

この関数の結果として考えられるエラー条件には、次のものがあります:

AD_AMSG_IPOは、この操作のための権限が不足していることを示します
AD_AMSG_IPWは、パスワードが正しくないことを示します
AD_AMSG_UNEは、ユーザーが存在しないことを示します
AD_MSGAR_NOSHUTDOWNは、アプリケーションをシャットダウンできないことを示します
ネットワーク・エラー: NET_TCP_HOSTSは、ホスト・ファイルで検索できないことを示します
ネットワーク・エラー: NET_NP_NOSERVERは、サーバーを検索できないことを示します

アクセス

この関数を使用するには、管理者権限を持っている必要があります。

例

         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