EsbLockObject

Description

EsbLockObject() locks an object on the server or client object system to prevent other users from updating it.

Syntax
EsbLockObject (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

hCtxEssbase VB API context handle. May be local context handle returned by EsbCreateLocalContext().
ObjTypeObject type (must be single type. Refer to Bitmask Data Types for a list of possible values.
AppNameApplication name.
DbNameDatabase name. If an empty string, uses the application sub-directory.
ObjNameName of an object to lock.

Return Value

None.

Notes

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 EsbLockObject 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_LockObject ()
   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

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

See Also

EsbGetObject()
EsbGetObjectInfo()
EsbListObjects()
EsbPutObject()
EsbUnlockObject()