# EsbGetObjectInfo

Description

EsbGetObjectInfo() gets information about a specific object on the server or locally on the client.

Syntax

    EsbGetObjectInfo (hCtx, ObjType, AppName, DbName, ObjName, ObjInfo)

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

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 Types" for a list of possible values.
AppName | Application name.
DbName | Database name. If an empty string, uses the Application sub-directory.
ObjName | Object name.
ObjInfo | Buffer to receive object info structure.

Return Value

If successful, returns an object structure containing information about the appropriate object in pObject.

Access

This function requires the caller to have the appropriate level of access to the specified application and/or database containing the object (depending on the object type).

Example

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

    Sub ESB_GetObjectInfo ()
       Dim sts As Long
       Dim AppName As String
       Dim DbName As String
       Dim ObjName As String
       Dim ObjType As Integer
       Dim Object As ESB_OBJINFO_T

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

       '**************************
       ' Get Object info structure
       '**************************
       sts = EsbGetObjectInfo (hCtx, ObjType, AppName,
             DbName, ObjName, Object)
    End Sub

See Also

EsbGetObject()
EsbListObjects()
EsbCreateLocalContext()