# EsbDeleteDatabase

Description

EsbDeleteDatabase() deletes an existing database from an application, either on the client or the server. If the database is running on the server, then it is first stopped.

Syntax

    EsbDeleteDatabase (hCtx, AppName, DbName)

    ByVal hCtx    As Long
    ByVal AppName As String
    ByVal DbName  As String

Parameters

hCtx | Essbase VB API context handle.
AppName | Name of an application containing database.
DbName | Name of a database to delete.

Return Value

None.

Notes

- Deleting a client database removes the local database directory and contents.
- Deleting a server database removes all objects associated with that database.

Access

For a server database, the caller must have database Create/Delete/Edit privilege (ESB_PRIV_DBCREATE).

Example

    Declare Function EsbDeleteDatabase Lib "ESBAPIW" (ByVal hCtx As Long, ByVal AppName As String, ByVal DbName As String) As Long
    Sub ESB_DeleteDatabase ()
       Dim sts As Long
       Dim AppName As String
       Dim DbName As String

       AppName = "Sample"
       DbName = "Basic"
       '****************
       ' Delete database
       '****************
       sts = EsbDeleteDatabase (hCtx, AppName, DbName)
    End Sub

See Also

EsbDeleteApplication()
EsbDeleteObject()