IMAPITable::SeekRow Method

Article
06/30/2010

Moves the table cursor to a specific position.

Syntax

HRESULT SeekRow(
    BOOKMARK bkOrigin,
    LONG lRowCount,
    LONG *lplRowsSought
);

Parameters

bkOrigin

BOOKMARK

Value of type BOOKMARK that specifies the starting position for the seek operation. A bookmark can be created using the IMAPITable::CreateBookmark method, or by passing one of the following values:

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.

lRowCount

LONG

Value of type LONG that specifies the number of rows to seek from bkOrigin.

lplRowsSought

LONG

Pointer to a variable of type LONG that receives the number of rows through which the seek operation has passed.

Return Value

HRESULT

The method can return one of the following values.

Return code	Description
S_OK	The operation completed successfully.
MAPI_E_BUSY	Another operation is in progress that prevents the operation from starting. Either the operation in progress should be allowed to complete itself, or it should be stopped.
MAPI_E_INVALID_BOOKMARK	The specified bookmark is invalid.
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 in the bkOrigin parameter has been removed, or if it is beyond the last row requested, the method returns MAPI_E_INVALID_BOOKMARK.

Requirements

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