Clears all loaded data in the active database.
Syntax
ESS_FUNC_M EssClearDatabase (hCtx);
Parameter | Data Type | Description |
---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
Notes
Data deleted using this function cannot be restored. Use it with care!
Return Value
None.
Access
This function requires the caller to have Write privilege (ESS_PRIV_WRITE) for the database, and to have selected it as their active database using EssSetActive().
Example
ESS_FUNC_M ESS_ClearDb (ESS_HCTX_T hCtx) { ESS_FUNC_M sts = ESS_STS_NOERR; sts = EssClearDatabase(hCtx); return (sts); }
See Also