# EsbClearDatabase

Description

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

Syntax

    EsbClearDatabase (hCtx)

    ByVal hCtx As Long

Parameters

hCtx | Essbase VB 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 (ESB_PRIV_WRITE) for the database, and to have selected it as their active database using EsbSetActive().

Example

    Declare Function EsbClearDatabase Lib "ESBAPIW" (ByVal hCtx As Long) As Long

    Sub ESB_ClearDatabase ()
       Dim sts As Long
       '***************
       ' Clear Database
       '***************
       sts = EsbClearDatabase (hCtx)
    End Sub

See Also

EsbDeleteDatabase()
EsbUnloadDatabase()
EsbSetActive()