EssGGetAPIInstance

Gets the API initialization instance handle.

Syntax

ESSG_FUNC_M EssGGetAPIInstance (Handle, pEssHinst);

Parameter	Data Type	Description
Handle	ESSG_HANDLE_T	Handle passed back from EssGInit.
pEssHinst	ESSG_PPVOID_T	Variable for the return of the API instance handle used by the Grid API.

Notes

This handle the caller to call non-Grid API functions that require an instance handle.

Return Value

If successful, returns ESSG_STS_NOERR.

Access

None.

Example

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

ESSG_FUNC_M    sts = ESS_STS_NOERR;
ESSG_PVOID_T   EssHinst;
ESSG_INIT_T    InitStruct;
ESSG_HANDLE_T  Handle;

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

/* initializes EGAPI */
sts = EssGInit(&InitStruct, Handle);
    
/* get API initialization instance handle */
if(!sts)
   sts = EssGGetAPIInstance(Handle, &EssHinst);