EssGCancelOperation

Cancels an operation at any stage during an operation.

Syntax

ESSG_FUNC_M EssGCancelOperation (hGrid, ulOptions);
ParameterData TypeDescription

hGrid

ESSG_HGRID_T

Handle passed back from EssGNewGrid.

ulOptions

ESSG_ULONG_T

Reserved for future use. Should be set to zero.

Notes

Return Value

If successful, returns ESSG_STS_NOERR.

Access

None.

Example

ESSG_VOID_T EssGCancelOperation (ESSG_HGRID_T hGrid)

{
  ESSG_FUNC_M     sts = ESS_STS_NOERR;
  ESSG_ULONG_T          ulOptions;
  ESSG_STR_T            pszReportIn;

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

  if(sts == 0)
  {
     pszReportIn = "{TabDelim}<idesc Year !";
     ulOptions = ESSG_NOATTRIBUTES;
     sts = EssGBeginReport(hGrid, pszReportIn,
           ulOptions);
  }

  if(sts == 0)
  {
     ulOptions = 0;
     sts = EssGCancelOperation(hGrid, ulOptions);
  }

  if(!sts)
  {
     EssGDisconnect(hGrid, 0);
  }
}

See Also