# EsbOtlGetOutlineInfo

Description

EsbOtlGetOutlineInfo() returns information about the outline file.

Syntax

    EsbOtlGetOutlineInfo (hOutline, pInfo, pusCount)

    ByVal hOutline As Long
          pInfo    As ESB_OUTLINEINFO_T
          pusCount As Integer

Parameters

hOutline | Outline context handle.
pInfo | Return variable for the information structure. The ESB_OUTLINEINFO_T structure should be allocated by the caller.
pusCount | Return variable for the number of alias tables in the outline.

Return Value

Returns 0 if successful.

Notes

- The caller should call EsbGetNextItem() once for each alias table (returned in the pusCount variable).

Example

    Declare Function EsbOtlGetOutlineInfo Lib
    "ESBOTLW" (ByVal hOutline As Long, pInfo As ESB_OUTLINEINFO_T,
    pusCount As Integer) As Long

    Sub ESB_OtlGetOutlineInfo()
    Dim sts As Long
    Dim Object As ESB_OBJDEF_T
    Dim hOutline As Long
    Dim Info As ESB_OUTLINEINFO_T
    Dim szAliasTable As String * ESB_ALIASNAMELEN
    Dim usCount As Integer

    Object.hCtx = hCtx
    Object.Type = ESB_OBJTYPE_OUTLINE
    Object.AppName = "Sample"
    Object.DbName = "Basic"
    Object.FileName = "Basic"

    sts = EsbOtlOpenOutline(hCtx, Object,
    ESB_YES, ESB_YES, hOutline)

    If sts = 0 Then
       sts = EsbOtlGetOutlineInfo(hOutline, Info, usCount)
        Do While sts = 0 And usCount > 0
         sts = EsbGetNextItem(hCtx, ESB_OUTLINEINFO_TYPE,
           ByVal szAliasTable)
         usCount = usCount - 1
       Loop
    End If
    End Sub

See Also

EsbOtlSetOutlineInfo()