EssShutdownServer

Essbaseエージェントを停止します。この関数はエージェント(ESSBASE.EXE)に対して、自身をシャットダウンするように要求を送信します。エージェントは、データのコミット、すべてのアプリケーションとデータベースの終了、ユーザーのログオフ後の停止など、通常のシャットダウン手順を実行します。

スーパーバイザ権限を持っているユーザーのみ、エージェントをシャットダウンできます。

この関数はいつでも呼び出せますが、通常はバックグラウンドで起動されたエージェントのシャットダウンのために呼び出します。詳細は、『Oracle Essbaseデータベース管理者ガイド』を参照してください。

構文

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

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

戻り値

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

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

アクセス

この関数を使用するには、スーパーバイザ権限を持っている必要があります。

例

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