# EssGGetGridOption

Description

EssGGetGridOption() gets individual grid options.

Syntax

    ESSG_FUNC_M EssGGetGridOption (hGrid, sOption, pOption);

ESSG_HGRID_T | hGrid
ESSG_SHORT_T | sOption
ESSG_PVOID_T | pOption

Parameters

hGrid | Handle passed back from EssGNewGrid().
sOption | Number indicating what option is being retrieved.
pOption | Pointer to the option retrieved. With the exception of the ESSG_OP_USERGRIDDATA pointer, this data is read-only and should not be freed by the caller.

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

Gets individual grid options.

Example

    ESSG_VOID_T EssG_GetGridOption(ESSG_HGRID_T hGrid)
    {
      ESSG_FUNC_M    sts = ESS_STS_NOERR;
      ESSG_SHORT_T         sOption;
      ESSG_SHORT_T         tmpShort;
      ESSG_PVOID_T         pOption;

      /* connect the grid to a database on the server */
      sts = EssGConnect(hGrid, "Rainbow", "Admin", "Password", "Demo", "Basic",
                       ESSG_CONNECT_DEFAULT);
      /* get grid option */
      sOption = ESSG_OP_DRILLLEVEL;
      pOption = &tmpShort;
      if(!sts)
         sts = EssGGetGridOption(hGrid, sOption, pOption);
      if(!sts)
      {
         printf("\n%s: %d", "DRILLLEVEL", tmpShort);
         EssGDisconnect(hGrid, 0);
      }
    }

See Also

Using the Grid API Functions
Grid API Structures
EssGSetGridOption