EssGGetAPIContext

この関数は、指定したグリッドのAPIログイン・コンテキスト・ハンドルを取得します。

構文

            ESSG_FUNC_M 
            EssGGetAPIContext
             (
            hGrid, pEssHctx
            );

パラメータ	データ型	説明
hGrid	ESSG_HGRID_T	EssGNewGridから戻されるハンドル。
pEssHctx	ESSG_PPVOID_T	接続したグリッドのAPIコンテキスト・ハンドルが戻される変数。

備考

そのため、ログイン・コンテキスト・ハンドルを必要とするグリッド以外のAPI関数を呼出し元で呼び出せます。
サーバーとの接続が無効な場合、有効なAPIのコンテキスト・ハンドルを取得できないため、呼出しが失敗し、*pEssHctxはESS_INVALID_HCTXに設定されます。
コンテキスト情報を変更する可能性のあるAPI関数では、戻されたログイン・コンテキストを使用しないでください。

戻り値

正常終了の場合は、ESSG_STS_NOERRが戻されます。

例

         #include <essapin.h>
#include <essgapin.h>

ESSG_FUNC_M     sts = ESS_STS_NOERR;
ESSG_INIT_T     InitStruct;
ESSG_HANDLE_T   Handle;
ESSG_PVOID_T    EssHctx;
ESSG_HGRID_T    hGrid;

InitStruct.ulVersion = ESSG_VERSION;
InitStruct.ulMaxRows = 1000;
InitStruct.ulMaxColumns = 200;
InitStruct.pfnMessageFunc = ESS_NULL;
InitStruct.pUserdata = ESS_NULL;

/* initializes EGAPI */
sts = EssGInit(&InitStruct, Handle);

if(!sts)
   sts = EssGNewGrid(Handle, &hGrid);
    
/* connect the grid to a database on the server */
if(!sts) 
   sts = EssGConnect(hGrid, "Rainbow", "Admin", 
         "Password", "Demo",
         "Basic", ESSG_CONNECT_DEFAULT);

/* Get API context handle for the specified grid */
if(!sts)
   sts = EssGGetAPIContext(hGrid, &EssHctx);
}