# EssClearDatabase

Description

EssClearDatabase() clears all loaded data in the active database.

Syntax

    ESS_FUNC_M EssClearDatabase (hCtx);

ESS_HCTX_T | hCtx

Parameters

hCtx | Essbase API context handle.

Return Value

None.

Notes

- Data deleted using this function cannot be restored. Use it with care!

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

EssDeleteDatabase()
EssUnloadDatabase()
EssSetActive()