HrQueryAllRows
The HrQueryAllRows
function retrieves all rows of a table.
Quick Info
|
Header
file: |
MAPIUTIL.H |
|
Implemented
by: |
MAPI |
|
Called by: |
Client
applications and service providers |
HRESULT HrQueryAllRows(
|
LPMAPITABLE ptable,
|
|
|
LPSPropTagArray ptaga, |
|
|
LPSRestriction pres, |
|
|
LPSSortOrderSet psos, |
|
|
LONG crowsMax,
|
|
|
LPSRowSet FAR * pprows |
|
|
); |
|
Parameters
ptable
[in] Pointer
to the MAPI table from which rows are retrieved.
ptaga
[in] Pointer
to an SPropTagArray
structure containing an array of property tags indicating the properties that
identify each column in the table. These tags are used to select the table
columns to be retrieved. If the ptaga parameter is NULL, HrQueryAllRows
retrieves the column set of the current table view passed in the ptable parameter.
pres
[in] Pointer
to an SRestriction
structure containing retrieval restrictions. If the pres parameter is
NULL, the calling implementation makes no restrictions.
psos
[in] Pointer
to an SSortOrderSet
structure identifying the sort order of the columns to be retrieved. If the psos
parameter is NULL, the default sort order for the table is used.
crowsMax
[in] Maximum
number of rows to be retrieved. If the value of the crowsMax parameter
is zero, no limit on the number of rows retrieved is set.
pprows
[out] Pointer
to the returned SRowSet
structure containing the retrieved table rows.
Return Values
S_OK
The call
retrieved the expected rows of a table.
MAPI_E_TABLE_TOO_BIG
The number of
rows in the table is larger than the number passed for the crowsMax
parameter.
Remarks
When querying
all rows of a table, a client application or service provider should call HrQueryAllRows
instead of the IMAPITable::QueryRows method.
See Also
IMAPITable
: IUnknown