EssLogoutUser

スーパーバイザまたはアプリケーション・デザイナが他のユーザーをEssbaseサーバーから切断できるようにします。

構文

            ESS_FUNC_M EssLogoutUser (
            hCtx, LoginId
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	ログアウトを強制するユーザーのAPIコンテキスト・ハンドル。
LoginId	ESS_LOGINID_T	ログアウトされるユーザーのログインID。

備考

LoginIdは、EssListConnections関数によって戻されるユーザー情報構造体から取得できます。
この関数は指定されたLoginIDが示すログインのみをログアウトさせます。その他のログインまたはコンテキストは影響を受けません。
スーパーバイザは、hCtxにログインしたサーバーにログインしたユーザーをログアウトできます。アプリケーション・デザイナは、hCtxをアプリケーション・デザイナとして、アプリケーションに接続しているユーザーのみをログアウトできます。自分自身はログアウトできません。

戻り値

なし。

アクセス

この関数を呼び出すには、スーパーバイザまたはアプリケーション・デザイナ権限を持っている必要があります。

例

         ESS_FUNC_M ESS_LogoutUser (ESS_HCTX_T hCtx,
ESS_HINST_T hInst)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_USHORT_T usrcnt;
ESS_PUSERINFO_T users;
sts = EssListConnections(hCtx, &usrcnt,
&users);
if(!sts)
{
if(usrcnt > 0)
{
/***************************************
* Log out first user from the list *
***************************************/
sts = EssLogoutUser(hCtx, users[0].LoginId);
if(!sts)
EssFree(hInst, users);
}
}
return(sts);
}