# EssClearActive

Description

EssClearActive() clears the user's current active application and database.

Syntax

    ESS_FUNC_M EssClearActive (hCtx);

ESS_HCTX_T | hCtx

Parameters

hCtx | Essbase API context handle.

Return Value

None.

Access

This function requires no special privileges.

Example

    ESS_FUNC_M
    ESS_UnloadDb (ESS_HCTX_T  hCtx)
    {
       ESS_FUNC_M        sts = ESS_STS_NOERR;
       ESS_STR_T        AppName;
       ESS_STR_T        DbName;
       AppName = "Sample";
       DbName  = "Basic";
       /*
        * IF the current active is the same as the
        * unload db, ClearActive first
        */
           sts = EssClearActive(hCtx);
       /*
        * ELSE
        *
        */
           sts = EssUnloadDatabase(hCtx, AppName,
                 DbName);
       return (sts);
    }

See Also

EssGetActive()
EssSetActive()