EssGDestroyGrid

Destroys a grid instance.

Syntax

ESSG_FUNC_M EssGDestroyGrid (hGrid)

Parameter	Data Type	Description
hGrid	ESSG_HGRID_T	Handle passed back from EssGNewGrid.

Notes

Frees any memory associated with the passed grid handle, and makes the handle invalid.

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_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);

/* destroys a grid instance */
if(!sts)
   sts = EssGDestroyGrid(hGrid);