# EssGNewGrid

Description

EssGNewGrid() initializes a specific grid.

Syntax

    ESSG_FUNC_M EssGNewGrid (Handle, phGrid);

ESSG_HANDLE_T | Handle; /* IN */
ESSG_PHGRID_T | phGrid; /* OUT */

Parameters

`Handle` | Handle passed back from EssGInit.
phGrid | Pointer to the grid-specific handle sent back from the EGAPI.

Return Value

If successful, returns `ESSG_STS_NOERR`.

Notes

- Initializes a specific grid.
- This call is required prior to calling any grid-specific API.
- The handle returned should be passed to any subsequent grid-specific API call that manipulates the specific grid.
- The call should be made once for each grid that uses the Essbase Grid API.
- Each thread in a multithreaded environment must use its own handle (phGrid) to call a grid-specific API, such as EssGSendRows() or EssGBeginOperation().

Access

None.

Example

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

    ESSG_FUNC_M     sts = ESS_STS_NOERR;
    ESSG_INIT_T     InitStruct;
    ESSG_HANDLE_T   Handle;
    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);

    /* initializes a specific grid */
    if(!sts)
       sts = EssGNewGrid(Handle, &hGrid);

See Also

Using the Grid API Functions
Grid API Structures