EssInit

APIおよびメッセージ・データベースを初期化します。

構文

            ESS_FUNC_M EssInit (
            pInitStruct, phInstance
            );

パラメータ	データ型	説明
pInitStruct	ESS_INIT_T	API初期化構造体へのポインタ。
phInstance	ESS_PHINST_T	Essbase APIインスタンス・ハンドルへのポインタ。

備考

この関数は、他のすべてのEssbase API関数よりも前に呼び出す必要があります。
初期化構造体のいずれかのフィールドがNULLまたは値0(適切な場合)の場合は、APIはこれらのパラメータにデフォルト値を使用します。

戻り値

この関数に渡されるESS_INIT_T構造体は、多数の初期化パラメータを含んでいます。これらのパラメータとしてメッセージ・データベースの名前、割り当てられるクライアント・バッファの最大サイズ、ユーザー定義のメモリー解放割り当て、エラー・コールバック関数へのポインタ、ヘルプ・ファイルの名前、場所およびバージョン番号が含まれます。

この関数は、複数のアプリケーションが独立してAPIにアクセスできるようにするphInstanceインスタンス・ハンドルを戻します(DLLの場合のみ)。インスタンス・ハンドルは保存し、EssLogin、EssTermおよびメモリー割当て関数に渡す必要があります。

アクセス

この関数を使用するのに、特別な権限は必要ありません。

例

         ESS_VOID_T ESS_Init()
{
  ESS_HINST_T   hInst;
  ESS_INIT_T InitStruct =        /* Define init */
                        /* structure */ 
  { 
    ESS_API_VERSION,       /* Version of API */
    USER,      /* user-defined message context */
    0,         /* max handles     */
    0L,        /* max buffer size */
    "C:\\Essbase", /* local path */
    /* The following parameters use defaults  */
    NULL,      /* message db path */
    NULL,      /* allocation function pointer */
    NULL,      /* reallocation function pointer */
    NULL,      /* free function pointer */
    NULL,   /* error handling function pointer */
    NULL,      /* path name of user-defined */
               /* Application help file */
    NULL,      /* Reserved for internal use. */
               /* Set to NULL */
  };
/* Initialize the API  */
if ((sts = EssInit (&InitStruct, &hInst)) != ESS_STS_NOERR)
{
    /* error initializing API */
    exit ((ESS_USHORT_T) sts);
 }