IMAPITable Interface

IID_IMAPITable

{00020301-0000-0000-C000-000000000046}

The IMAPITable interface is used to provide a read-only view of a table. IMAPITable is used by clients and service providers to manipulate the way a table appears.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPITable Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error on the table.

Advise

Registers to receive notification of specified events affecting the table.

Unadvise

Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method.

GetStatus

Returns the table's status and type.

SetColumns

Defines the particular properties and order of properties to appear as columns in the table.

QueryColumns

Returns a list of columns for the table.

GetRowCount

Returns the total number of rows in the table.

SeekRow

Moves the cursor to a specific position in the table.

SeekRowApprox

Moves the cursor to an approximate fractional position in the table.

QueryPosition

Retrieves the current table row position of the cursor, based on a fractional value.

FindRow

Finds the next row in a table that matches specific search criteria.

Restrict

Applies a filter to a table, reducing the row set to only those rows matching the specified criteria.

CreateBookmark

Marks the table's current position.

FreeBookmark

Releases the memory associated with a bookmark.

SortTable

Orders the rows of the table based on sort criteria.

QuerySortOrder

Retrieves the current sort order for a table.

QueryRows

Returns one or more rows from a table, beginning at the current cursor position.

Abort

Stops any asynchronous operations currently in progress for the table.

ExpandRow

Expands a collapsed table category, adding the leaf rows belonging to the category to the table view.

CollapseRow

Collapses an expanded table category, removing the leaf rows belonging to the category from the table view.

WaitForCompletion

Suspends processing until one or more asynchronous operations in progress on the table have completed.

GetCollapseState

Returns the data necessary to rebuild the current collapsed or expanded state of a categorized table.

SetCollapseState

Rebuilds the current expanded or collapsed state of a categorized table using data that was saved by a prior call to the IMAPITable::GetCollapseState method.

GetLastError

FUNCTION IMAPITable_GetLastError ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL hResultCode AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppMAPIError AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[3] USING IMAPITable_GetLastError (pIMAPITable, hResultCode, ulFlags, lppMAPIError) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Advise

FUNCTION IMAPITable_Advise ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulEventMask AS DWORD _
, BYVAL lpAdviseSink AS DWORD _
, BYREF lpulConnection AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[4] USING IMAPITable_Advise (pIMAPITable, ulEventMask, lpAdviseSink, lpulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Unadvise

FUNCTION IMAPITable_Unadvise ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulConnection AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[5] USING IMAPITable_Unadvise(pIMAPITable, ulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetStatus

FUNCTION IMAPITable_GetStatus ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpulTableStatus AS DWORD _
, BYREF lpulTableType AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[6] USING IMAPITable_GetStatus (pIMAPITable, lpulTableStatus, lpulTableType) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetColumns

FUNCTION IMAPITable_SetColumns ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL lpPropTagArray AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[7] USING IMAPITable_SetColumns (pIMAPITable, lpPropTagArray, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

QueryColumns

FUNCTION IMAPITable_QueryColumns ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lpPropTagArray AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[8] USING IMAPITable_QueryColumns (pIMAPITable, ulFlags, lpPropTagArray) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetRowCount

FUNCTION IMAPITable_GetRowCount ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lpulCount AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[9] USING IMAPITable_GetRowCount (pIMAPITable, ulFlags, lpulCount) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SeekRow

FUNCTION IMAPITable_SeekRow ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL bkOrigin AS LONG _
, BYVAL lRowCount AS LONG _
, BYREF lplRowsSought AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[10] USING IMAPITable_SeekRow (pIMAPITable, bkOrigin, lRowCount, lplRowsSought) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SeekRowApprox

FUNCTION IMAPITable_SeekRowApprox ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulNumerator AS DWORD _
, BYVAL ulDenominator AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[11] USING IMAPITable_SeekRowApprox (pIMAPITable, ulNumerator, ulDenominator) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

QueryPosition

FUNCTION IMAPITable_QueryPosition ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpulRow AS DWORD _
, BYREF lpulNumerator AS DWORD _
, BYREF lpulDenominator AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[12] USING IMAPITable_QueryPosition (pIMAPITable, lpulRow, lpulNumerator, lpulDenominator) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FindRow

FUNCTION IMAPITable_FindRow ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpRestriction AS SRestriction _
, BYVAL BkOrigin AS LONG _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[13] USING IMAPITable_FindRow (pIMAPITable, lpRestriction, BkOrigin, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Restrict

FUNCTION IMAPITable_Restrict ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpRestriction AS SRestriction _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[14] USING IMAPITable_Restrict (pIMAPITable, lpRestriction, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CreateBookmark

FUNCTION IMAPITable_CreateBookmark ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpbkPosition AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[15] USING IMAPITable_CreateBookmark (pIMAPITable, lpbkPosition) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FreeBookmark

FUNCTION IMAPITable_FreeBookmark ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL bkPosition AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[16] USING IMAPITable_FreeBookmark (pIMAPITable, bkPosition) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SortTable

FUNCTION IMAPITable_SortTable ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpSortCriteria AS SSortOrderSet _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[17] USING IMAPITable_SortTable (pIMAPITable, lpSortCriteria, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

QuerySortOrder

FUNCTION IMAPITable_QuerySortOrder ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYREF lpSortCriteria AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[18] USING IMAPITable_QuerySortOrder (pIMAPITable, lpSortCriteria) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

QueryRows

FUNCTION IMAPITable_QueryRows ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL lRowCount AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppRows AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[19] USING IMAPITable_QueryRows (pIMAPITable, lRowCount, ulFlags, lppRows) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Abort

FUNCTION IMAPITable_Abort ( _
  BYVAL pIMAPITable AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[20] USING IMAPITable_Abort (pIMAPITable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ExpandRow

FUNCTION IMAPITable_ExpandRow ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL cbInstanceKey AS DWORD _
, BYVAL pbInstanceKey AS BYTE PTR _
, BYVAL ulRowCount AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYREF lppRows AS DWORD _
, BYREF lpulMoreRows AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[21] USING IMAPITable_ExpandRow (pIMAPITable, cbInstanceKey, pbInstanceKey, ulRowCount, ulFlags, lppRows, lpulMoreRows) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CollapseRow

FUNCTION IMAPITable_CollapseRow ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL cbInstanceKey AS DWORD _
, BYVAL pbInstanceKey AS BYTE PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lpulRowCount AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[22] USING IMAPITable_CollapseRow (pIMAPITable, cbInstanceKey, pbInstanceKey, ulFlags, lpulRowCount) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

WaitForCompletion

FUNCTION IMAPITable_WaitForCompletion ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL ulTimeout AS DWORD _
, BYREF lpulTableStatus AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[23] USING IMAPITable_WaitForCompletion (pIMAPITable, ulFlags, ulTimeout, lpulTableStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetCollapseState

FUNCTION IMAPITable_GetCollapseState ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL cbInstanceKey AS DWORD _
, BYVAL lpbInstanceKey AS BYTE PTR _
, BYREF lpcbCollapseState AS DWORD _
, BYREF lppbCollapseState AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[24] USING IMAPITable_GetCollapseState (pIMAPITable, ulFlags, cbInstanceKey, lpbInstanceKey, lpcbCollapseState, lppbCollapseState) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetCollapseState

FUNCTION IMAPITable_SetCollapseState ( _
  BYVAL pIMAPITable AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL cbCollapseState AS DWORD _
, BYVAL pbCollapseState AS DWORD _
, BYREF lpbkLocation AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPITable[25] USING IMAPITable_SetCollapseState (pIMAPITable, ulFlags, cbCollapseState, pbCollapseState, lpbkLocation) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION