IRowPosition::ClearRowPosition

Clears the value of the current hRow.

HRESULT ClearRowPosition ();

Parameters

None.

Return Code

S_OK
The method succeeded. Calling GetRowPosition returns a phRow value of DB_NULL_ROW and a pdwPositionFlag value of DBPOSITION_NOROW.

E_FAIL
A provider-specific error occurred. The row position is unchanged.

DB_E_CANCELED
The operation was canceled by a client during notification. The row position is unchanged.

E_UNEXPECTED
ClearRowPosition was called twice in a row.

There is no current rowset.

Comments

ClearRowPosition fires the following notification phases with the reason DBREASON_ROWPOSITION_CLEARED:

• DBEVENTPHASE_OKTODO
  
  
• DBEVENTPHASE_ABOUTTODO
  
  
• DBEVENTPHASE_FAILEDTODO (if either of the above events is canceled)

Calling SetRowPosition fires the remaining phases.

ClearRowPosition must be called prior to the first and any subsequent SetRowPosition calls.