EsbGetAttributeInfo

Returns attribute information for a given attribute member or dimension.

Syntax

EsbGetAttributeInfo (hCtx, AttrName, AttrInfo)
ByVal hCtx     As Long
ByVal AttrName As String
      AttrInfo As ESB_ATTRIBUTEINFO_T
ParameterDescription

hCtx

Context handle

AttrName

Name of the attribute member or dimension

AttrInfo

Attribute information

Notes

If a base member or dimension is passed in, information will be returned, but there is no attribute specific information to be displayed. Also, in the circumstance of a base dimension being passed in, the dimension and member name fields of the structure will hold identical values.

Return Value

Returns sts = 0 when successful and populates the ESB_ATTRIBUTEINFO_T structure. Otherwise returns an error number.

Access

This function requires no special privileges.

Example

Sub ESB_GetAttributeInfo()
   ' NOTE: 'Out' is a sub to print the output within quotes to a listbox or text box.
   Dim hCtx as long
   Dim sts as long
   Dim MbrName As String
   Dim OutAttrInfo As ESB_ATTRIBUTEINFO_T

   MbrName = InputBox("Member Name")
   sts = EsbGetAttributeInfo(hCtx, MbrName, OutAttrInfo)
   If sts = 0 Then
      Out "ESB_OtlGetAttributeInfo passed" & sts
      Out "MbrName : " & OutAttrInfo.MbrName
      Out "DimName : " & OutAttrInfo.DimName
      Out "Attribute : " & OutAttrInfo.Attribute
   Else
      Out "ESB_OtlGetAttributeInfo failed" & sts: Exit Sub
   End If
End Sub

See Also