# EsbUnlockObject

Description

EsbUnlockObject() unlocks a locked object on the server or client object system.

Syntax

    EsbUnlockObject (hCtx, ObjType, AppName, DbName, ObjName)

    ByVal hCtx    As Long
    ByVal ObjType As Long
    ByVal AppName As String
    ByVal DbName  As String
    ByVal objName As String

Parameters

hCtx | Essbase VB API context handle. Can be local context handle returned by EsbCreateLocalContext().
ObjType | Object type (must be single type). Refer to Bitmask Data Types for a list of possible values.
AppName | Application name.
DbName | Database name. If an empty string, uses the application sub-directory.
ObjName | Name of an object to unlock.

Return Value

None.

Notes

- To unlock an object, the object must already exist and be locked by the caller.

Access

This function requires the caller to have Application or Database Design privilege (ESB_PRIV_APPDESIGN or ESB_PRIV_DBDESIGN) for the specified application or database containing the object.

Example

    Declare Function EsbUnlockObject Lib "ESBAPIW" (ByVal hCtx As Long, ByVal ObjType As Integer, ByVal AppName As String, ByVal DbName As String, ByVal ObjName As String) As Long

    Sub ESB_UnlockObject ()
       Dim sts As Long
       Dim AppName As String
       Dim DbName As String
       Dim ObjName As String
       Dim ObjType As Integer

       AppName = "Sample"
       DbName = "Basic"
       ObjName = "Basic"
       ObjType = ESB_OBJTYPE_OUTLINE

       '******************
       ' UnLock Rules Object
       '******************
       sts = EsbUnlockObject (hCtx, ObjType, AppName,
             DbName, ObjName)
    End Sub

See Also

EsbGetObject()
EsbGetObjectInfo()
EsbListObjects()
EsbLockObject()
EsbPutObject()