IRowsetLocate Interface

IID_IRowsetLocate

{0C733A7D-2A1C-11CE-ADE5-00AA0044773D}

IRowsetLocate is the interface for fetching arbitrary rows of a rowset. A rowset that does not implement this interface is a sequential rowset. IRowsetLocate is a prerequisite for IRowsetScroll.

Documentation: IRowsetLocate

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IRowset Methods

Description

AddRefRows

Adds a reference count to an existing row handle.

GetData

Retrieves data from the rowset's copy of the row.

GetNextRows

Fetches rows sequentially, remembering the previous position.

ReleaseRows

Releases rows.

RestartPosition

Repositions the next fetch position to its initial position; that is, its position when the rowset was first created.

IRowsetLocate Methods

Description

Compare

Compares two bookmarks.

GetRowsAt

Fetches rows, starting with the row specified by an offset from a bookmark.

GetRowsByBookmark

Fetches the rows that match the specified bookmarks.

Hash

Returns hash values for the specified bookmarks.

QueryInterface

FUNCTION IRowsetLocate_QueryInterface ( _

  BYVAL pthis AS DWORD PTR _

, BYREF riid AS GUID _

, BYREF ppvObj AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[0] USING IRowsetLocate_QueryInterface (pthis, riid, ppvObj) TO HRESULT
  FUNCTION = HRESULT
 

END FUNCTION

AddRef

FUNCTION IRowsetLocate_AddRef ( _

  BYVAL pthis AS DWORD PTR _

  ) AS DWORD
 

  LOCAL DWRESULT AS LONG
  CALL DWORD @@pthis[1] USING IRowsetLocate_AddRef (pthis) TO DWRESULT
  FUNCTION = DWRESULT
 

END FUNCTION

Release

FUNCTION IRowsetLocate_Release ( _

  BYVAL pthis AS DWORD PTR _

  ) AS DWORD
 

  LOCAL DWRESULT AS DWORD
  CALL DWORD @@pthis[2] USING IRowsetLocate_Release (pthis) TO DWRESULT
  FUNCTION = DWRESULT
 

END FUNCTION

AddRefRows

FUNCTION IRowsetLocate_AddRefRows ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL cRows AS DWORD _

, BYVAL rghRows AS DWORD _

, BYREF rgRefCounts AS DWORD _

, BYREF rgRowStatus AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IRowsetLocate_AddRefRows (pthis, cRows, rghRows, rgRefCounts, rgRowStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetData

FUNCTION IRowsetLocate_GetData ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hRow AS DWORD _

, BYVAL hAccessor AS DWORD _

, BYREF pData AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IRowsetLocate_GetData (pthis, hRow, hAccessor, pData) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetNextRows

FUNCTION IRowsetLocate_GetNextRows ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

, BYVAL lRowsOffset AS LONG _

, BYVAL cRows AS LONG _

, BYREF pcRowsObtained AS DWORD _

, BYREF prghRows AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IRowsetLocate_GetNextRows (pthis, hChapter, lRowsOffset, cRows, pcRowsObtained, prghRows) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ReleaseRows

FUNCTION IRowsetLocate_ReleaseRows ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL cRows AS DWORD _

, BYVAL rghRows AS DWORD _

, BYVAL rgRowOptions AS DWORD _

, BYREF rgRefCounts AS DWORD _

, BYREF rgRowStatus AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IRowsetLocate_ReleaseRows (pthis, cRows, rghRows, rgRowOptions, rgRefCounts, rgRowStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

RestartPosition

FUNCTION IRowsetLocate_RestartPosition ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IRowsetLocate_RestartPosition (pthis, hChapter) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Compare

FUNCTION IRowsetLocate_Compare ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

, BYVAL cbBookmark1 AS DWORD _

, BYVAL pBookmark1 AS DWORD _

, BYVAL cbBookmark2 AS DWORD _

, BYVAL pBookmark2 AS DWORD _

, BYREF pComparison AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IRowsetLocate_Compare (pthis, hChapter, cbBookmark1, pBookmark1, cbBookmark2, pBookmark2, pComparison) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetRowsAt

FUNCTION IRowsetLocate_GetRowsAt ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hReserved1 AS DWORD _

, BYVAL hChapter AS DWORD _

, BYVAL cbBookmark AS DWORD _

, BYVAL pBookmark AS DWORD _

, BYVAL lRowsOffset AS LONG _

, BYVAL cRows AS LONG _

, BYREF pcRowsObtained AS DWORD _

, BYREF prghRows AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IRowsetLocate_GetRowsAt (pthis, hReserved1, hChapter, cbBookmark, lRowsOffset, cRows, pcRowsObtained, pcRowsObtained, prghRows) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetRowsByBoomark

FUNCTION IRowsetLocate_GetRowsByBookmark ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

, BYVAL cRows AS DWORD _

, BYVAL rgcbBookmarks AS DWORD _

, BYVAL rgpBookmarks AS DWORD _

, BYREF rghRows AS DWORD _

, BYREF rgRowStatus AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IRowsetLocate_GetRowsByBookmark (pthis, hChapter, cRows, rgcbBookmarks, rgpBookmarks, rghRows, rgRowStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetRowsByBoomark

FUNCTION IRowsetLocate_Hash ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

, BYVAL cBookmarks AS DWORD _

, BYVAL rgcbBookmarks AS DWORD _

, BYVAL rgpBookmarks AS DWORD _

, BYREF rgHashedValues AS DWORD _

, BYREF rgBookmarkStatus AS DWORD _

) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IRowsetLocate_Hash (pthis, hChapter, cBookmarks, rgcbBookmarks, rgpBookmarks, rgHashedValues, rgBookmarkStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION