EssGUnlock

Description

EssGUnlock() unlocks any blocks that were locked at the server.

Syntax

ESSG_FUNC_M EssGUnlock (hGrid, ulOptions);
ESSG_HGRID_T hGrid
ESSG_ULONG_T ulOptions

Parameters

hGridHandle passed back from EssGNewGrid.
ulOptionsReserved for future use. Should be set to zero.

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

Access

None.

Example

ESSG_VOID_T ESSG_Unlock(ESSG_HGRID_T hGrid)

{
  ESSG_FUNC_M    sts = ESS_STS_NOERR;
  ESSG_ULONG_T         ulOptions = 0;
   
   /* connect the grid to a database on the server */
  sts = EssGConnect(hGrid, "Rainbow", "Admin", "Password", "Demo", "Basic",
        ESSG_CONNECT_NODIALOG);

  /* unlock the locked blocks at server */
  if(!sts)
     sts = EssGUnlock(hGrid, ulOptions);

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

See Also

Using the Grid API Functions
Grid API Structures