IMAPITable::FindRow Method

Article
06/30/2010

Finds the next row in a table that contains a property matching the specified criteria.

Syntax

HRESULT FindRow(
    SRestriction *lpRestriction,
    BOOKMARK bkOrigin,
    ULONG ulFlags
);

Parameters

lpRestriction

SRestriction

Pointer to a variable of type SRestriction that specifies the property to search for.

bkOrigin

BOOKMARK

Value of type BOOKMARK identifying the row where IMAPITable::FindRow begins its search. The following flags can be set:

BOOKMARK_BEGINNING

Starts the operation from the beginning of the table.

BOOKMARK_CURRENT

Starts the operation from the row in the table where the cursor is located.

BOOKMARK_END

Starts the operation from the end of the table.

ulFlags

ULONG

Value of type ULONG that specifies the bitmask of flags controlling the direction of the search. The default direction is forward. The following flag can be set:

DIR_BACKWARD

Searches backward from the row identified by the specified bookmark.

Return Value

HRESULT

The method can return one of the following values.

Return code	Description
S_OK	The operation completed successfully.
MAPI_E_INVALID_BOOKMARK	The specified bookmark is invalid.
MAPI_E_NOT_FOUND	No match was found.
MAPI_W_POSITION_CHANGED	The operation succeeded, but the bookmark specified 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 must be handled as successful. To test for this warning, use the FAILED macro.

Remarks

If the bookmark specified in the bkOrigin parameter has been removed or is beyond the last row requested, the method returns E_INVALID_BOOKMARK. If no rows are found that match the restriction, the method returns MAPI_E_NOT_FOUND.

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Product	Internet Explorer 4.0
Header	Wabdefs.h
DLL	Wab32.dll

Share via