IABTable::FindRow


		Contents Index Topic Contents
	Previous Topic: IABTable::ExpandRow Next Topic: IABTable::FreeBookmark

IABTable::FindRow
HRESULT FindRow(
    LPSRestriction  lpRestriction,
    BOOKMARK  BkOrigin,
    ULONG     ulFlags
);
Find the next row in a table that contains a property matching the specified criteria.
Returns one of the following values:

S_OK The find operation was successful.

MAPI_E_INVALID_BOOKMARK The bookmark in the BkOrigin parameter is invalid because it has been removed or because it is beyond the last row requested.

MAPI_E_NOT_FOUND No rows were found that matched the restriction.

MAPI_W_POSITION_CHANGED The call succeeded, but the bookmark used in the operation is no longer set at the same row as when it was last used; if the bookmark has not been used, it is no longer in the same position as when it was created. When this warning is returned, the call should be handled as successful. To test for this warning, use the FAILED macro.

lpRestriction
Address of an SRestriction structure that describes the search criteria.
BkOrigin
Bookmark identifying the row where FindRow should begin its search. A bookmark can be created using the CreateBookmark method, or one of the following predefined values can be passed:

BOOKMARK_BEGINNING Searches from the beginning of the table

BOOKMARK_CURRENT Searches from the row in the table where the cursor is located.

BOOKMARK_END Searches from the end of the table.

ulFlags
Bitmask of flags that control the direction of the search. The following flag can be set:

DIR_BACKWARD Searches backward from the row identified by the bookmark.

Back to top

Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.

S_OK	The find operation was successful.
MAPI_E_INVALID_BOOKMARK	The bookmark in the BkOrigin parameter is invalid because it has been removed or because it is beyond the last row requested.
MAPI_E_NOT_FOUND	No rows were found that matched the restriction.
MAPI_W_POSITION_CHANGED	The call succeeded, but the bookmark used in the operation is no longer set at the same row as when it was last used; if the bookmark has not been used, it is no longer in the same position as when it was created. When this warning is returned, the call should be handled as successful. To test for this warning, use the FAILED macro.

BOOKMARK_BEGINNING	Searches from the beginning of the table
BOOKMARK_CURRENT	Searches from the row in the table where the cursor is located.
BOOKMARK_END	Searches from the end of the table.