EssResetDatabase

Clears all loaded data and resets the outline to be empty in the active database.

Syntax

ESS_FUNC_M EssResetDatabase (hCtx);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.

Notes

Data deleted and outlines reset using this function cannot be restored. Use it with care!
This function call is asynchronous. Call EssGetProcessState() after making this call until EssGetProcessState() returns a status indicating that the reset database operation is complete.

Return Value

None.

Access

This function requires that the caller have Write privilege (ESS_PRIV_WRITE) for the database, and to select it as the active database using EssSetActive().

Example

  ESS_FUNC_M
  ESS_ResetDb (ESS_HCTX_T     hCtx)
  {
     ESS_FUNC_M        sts = ESS_STS_NOERR;
     ESS_PROCSTATE_T pState;
     sts = EssResetDatabase(hCtx);
  
     if (!sts)
     {
        sts = EssGetProcessState (hCtx, &pState);
        while(!sts && (pState.State != ESS_STATE_DONE))
           sts = EssGetProcessState (hCtx, &pState);
     }
     return (sts);
  }