# EssGetFilterRow

Description

EssGetFilterRow() gets the next row of a filter.

Syntax

    ESS_FUNC_M EssGetFilterRow (hCtx, pRowString, pAccess);

ESS_HCTX_T | hCtx
ESS_PSTR_T | pRowString
ESS_PACCESS_T | pAccess

Parameters

hCtx | Essbase API context handle.
pRowString | Address of pointer to receive the next row of the filter.
pAccess | Address of variable to receive the access level for the filter row. Possible values are listed in Bitmask Data Types.

Return Value

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

Notes

- This function should be called repeatedly after calling EssGetFilter(), until a NULL row string pointer is returned.
- The memory allocated for pRowString should be freed using EssFree().

Access

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

Example

See the example of EssGetFilter().

See Also

EssGetFilter()
EssListFilters()