# EsbGetFilterRow

Description

EsbGetFilterRow() gets the next row of a filter.

Syntax

    EsbGetFilterRow (hCtx, FltRow, szRow, pAccess)

    ByVal hCtx    As Long
    ByVal FltRow  As String
    ByVal szRow   As Integer
    ByVal pAccess As Integer

Parameters

hCtx | Essbase VB API context handle.
FltRow | Buffer to receive the next row of the filter.
szRow | Size of the buffer to receive the next row of the filter.
pAccess | Address of variable to receive the access level for the filter row.

Return Value

If successful, returns the next filter row (if any) in RowString, and the row access level in pAccess.

Notes

- This function should be called repeatedly after calling EsbGetFilter(), until an empty string is returned.
- If the filter row string length is greater that the size of the buffer, the filter row is truncated.

Access

This function requires the caller to have Database Design privilege (ESB_PRIV_DBDESIGN) for the specified database.

Example

    Declare Function EsbGetFilterRow Lib "ESBAPIW" (ByVal hCtx As Long, ByVal FltRow As String, ByVal szRow As Integer, Access As Integer) As Long
    See the example for EsbGetFilter().

See Also

EsbGetFilter()
EsbListFilters()