IRowsetIndex Interface

IID_IRowsetIndex

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

IRowsetIndex is the primary interface for exposing index functionality in OLE DB. For a complete description of indexes, see Chapter 10: Index Rowsets, and Chapter 11: Integrated Indexes.

Documentation: IRowsetIndex

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IRowsetChange Methods

Description

DeleteRows

Deletes rows.

SetData

Sets data in one or more columns in a row.

InsertRow

Creates and initializes a new row.

IRowsetIndex Methods

Description

GetIndexInfo

Returns information about the index rowset capabilities.

Seek

Allows direct positioning at a key value within the current range.

SetRange

Restricts the set of row entries visible through calls to IRowset::GetNextRows and IRowsetIndex::Seek.

QueryInterface

FUNCTION IRowsetIndex_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 IRowsetIndex_QueryInterface (pthis, riid, ppvObj) TO HRESULT
  FUNCTION = HRESULT
 

END FUNCTION

AddRef

FUNCTION IRowsetIndex_AddRef ( _

  BYVAL pthis AS DWORD PTR _

  ) AS DWORD
 

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

END FUNCTION

Release

FUNCTION IRowsetIndex_Release ( _

  BYVAL pthis AS DWORD PTR _

  ) AS DWORD
 

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

END FUNCTION

DeleteRows

FUNCTION IRowsetIndex_DeleteRows ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

, BYVAL cRows AS DWORD _

, BYVAL rghRows AS DWORD _

, BYREF rgRowStatus AS DWORD _

  ) AS LONG

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

END FUNCTION

SetData

FUNCTION IRowsetIndex_SetData ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hRow AS DWORD _

, BYVAL hAccessor AS DWORD _

, BYVAL pData AS DWORD _

  ) AS LONG

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

END FUNCTION

InsertRow

FUNCTION IRowsetIndex_InsertRow ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hChapter AS DWORD _

, BYVAL hAccessor AS DWORD _

, BYVAL pData AS DWORD _

, BYREF phRow AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IRowsetIndex_InsertRow (pthis, hChapter, hAccessor, pData, phRow) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetIndexInfo

FUNCTION IRowsetIndex_GetIndexInfo ( _
  BYVAL pthis AS DWORD PTR _

, BYREF pcKeyColumns AS DWORD _

, BYREF prgIndexColumnDesc AS DWORD _

, BYREF pcIndexPropertySets AS DWORD _

, BYREF prgIndexPropertySets AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IRowsetIndex_GetIndexInfo (pthis, pcKeyColumns, prgIndexColumnDesc, pcIndexPropertySets, prgIndexPropertySets) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Seek

FUNCTION IRowsetIndex_Seek ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hAccessor AS DWORD _

, BYVAL cKeyValues AS DWORD _

, BYVAL pData AS DWORD _

, BYVAL dwSeekOptions AS DWORD _

  ) AS LONG

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

END FUNCTION

SetRange

FUNCTION IRowsetIndex_SetRange ( _
  BYVAL pthis AS DWORD PTR _

, BYVAL hAccessor AS DWORD _

, BYVAL cStartKeyColumns AS DWORD _

, BYVAL pStartData AS DWORD _

, BYVAL cEndKeyColumns AS DWORD _

, BYVAL pEndData AS DWORD _

, BYVAL dwRangeOptions AS DWORD _

  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IRowsetIndex_SetRange (pthis, hAccessor, cStartKeyColumns, pStartData, cEndKeyColumns, pEndData, dwRangeOptions) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION