EssGetApplicationState

ユーザーが構成可能なアプリケーションのパラメータが含まれている、アプリケーションの状態構造体を取得します。

構文

            ESS_FUNC_M EssGetApplicationState (
            hCtx, AppName, ppAppState
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
AppName	ESS_STR_T	アプリケーション名。
ppAppState	ESS_APPSTATE_T	割り当てられたアプリケーション状態構造体を受け取るポインタのアドレス。

備考

この関数はローカル・アプリケーションに対しては呼び出せません。この関数はサーバーのアプリケーションに対してのみ呼び出せます。
ppAppStateに対して割り当てられたメモリーは、EssFreeを使用して解放する必要があります。

戻り値

正常終了の場合、割り当てられたアプリケーション状態構造体へのポインタがppAppStateに戻されます。

アクセス

この関数を使用するには、呼出し元が少なくとも指定されたアプリケーションに対する読取りアクセス権(ESS_PRIV_READ)を持っている必要があります。

例

         ESS_FUNC_M
ESS_GetAppState (ESS_HCTX_T      hCtx,
                 ESS_HINST_T     hInst
                )
{
   ESS_FUNC_M         sts = ESS_STS_NOERR;
   ESS_PAPPSTATE_T   AppState;
   ESS_STR_T         AppName;
   AppName = "Sample";
   sts = EssGetApplicationState (hCtx, AppName,
         &AppState);
   if (!sts)
   {   
      if (AppState)
      {   
         EssFree (hInst, AppState);
      }
   }
   return (sts);
}