TABLE_NOTIFICATION

Platform SDK: MAPI

TABLE_NOTIFICATION

The TABLE_NOTIFICATION structure describes a row in a table that has been affected by some type of event, such as a change or an error, causing a table notification to be generated.

Quick Info

Header file:

MAPIDEFS.H

typedef struct _TABLE_NOTIFICATION 
{ 
     ULONG        ulTableEvent;  
     HRESULT      hResult;  
     SPropValue   propIndex;  
     SPropValue   propPrior;  
     SRow         row;
} TABLE_NOTIFICATION;

Members

ulTableEvent

Bitmask of flags used to represent the table event type. The following flags can be set:

TABLE_CHANGED

Indicates at a high level that something about the table has changed. The table's state is as it was before the event, meaning that all PR_INSTANCE_KEY properties, bookmarks, current positioning, and user interface selections are still valid.

Handle this event by re-reading the entire table. Service providers that do not want to implement "rich" table notifications simply send TABLE_CHANGED events rather than more detailed events to indicate a particular type of change.

TABLE_ERROR

An error has occurred, usually during the processing of an asynchronous operation. Errors during the processing of the following methods can generate this event:

IMAPITable::SortTable

IMAPITable::SetColumns

IMAPITable::Restrict

After receiving a TABLE_ERROR event, a client cannot rely on the accuracy of the table contents. Also, pending notifications about other changes might be lost.

The IMAPITable::GetLastError method might not provide any further information about the error because it was generated at some previous point, not necessarily from the last method call.

TABLE_RELOAD

The data in the table should be reloaded. Service providers send TABLE_RELOAD when, for example, the underlying data is stored in a database and the database is replaced.

Handle this event by assuming that nothing about the table is still valid and by re-reading the entire table. All bookmarks, instance keys, status and positioning information are invalid.

TABLE_RESTRICT_DONE

A restriction operation initiated with an IMAPITable::Restrict method call has completed.

TABLE_ROW_ADDED

A new row has been added to the table and the corresponding object saved. TABLE_ROW_ADDED events are generated after a call to the object's IMAPIProp::SaveChanges method.

TABLE_ROW_DELETED

A row has been removed from the table. The propPrior member is set to NULL.

TABLE_ROW_MODIFIED

A row has been changed. The row member contains the affected properties for the row. Multiple TABLE_ROW_MODIFIED events are sent in the order that they appear in the table view.

TABLE_ROW_MODIFIED events are sent after changes to the corresponding object have been committed with a call to the object's IMAPIProp::SaveChanges method. If the modified row is now the first row in the table, the value of the property tag in the propPrior member is PR_NULL.

TABLE_SETCOL_DONE

A column setting operation initiated with an IMAPITable::SetColumns method call has competed.

TABLE_SORT_DONE

A table sorting operation initiated with an IMAPITable::SortTable method call has competed.

hResult

HRESULT value for the error that has occurred, if the ulTableEvent member is set to TABLE_ERROR.

propIndex

SPropValue structure for the PR_INSTANCE_KEY property of the affected row.

propPrior

SPropValue structure for the PR_INSTANCE_KEY property of the row preceding the affected one. If the affected row is the first row in the table, propPrior must be set to PR_NULL and not zero. Zero is not a valid property tag.

row

SRow structure describing the affected row. This structure is filled for all table notification events. For table notification events that do not pass row data, the cValues member of the SRow structure is set to zero and the lpProps member is set to NULL.

Because this SRow structure is read-only; clients must make a copy of it if they want to make modifications. The ScDupPropSet function can be used to make the copy.

Remarks

The TABLE_NOTIFICATION structure is one of the members of the union of structures included in the info member of the NOTIFICATION structure. The info member includes a TABLE_NOTIFICATION structure when the ulEventType member of the structure is set to fnevTableModified.

The order and type of columns in the row member reflect the order and type that was in effect at the time that the notification was generated, which is not necessarily the same as when the notification was delivered.

For more information about notification, see the topics described in the following table.

Topic	Description
Event Notification in MAPI	General overview of notification and notification events.
Handling Notifications	Discussion of how clients should handle notifications.
Supporting Event Notification	Discussion of how service providers can use the IMAPISupport method to generate notifications.

Because table notifications are asynchronous, it is possible to receive notification of an added row after learning about the addition through another means. It is possible to receive a TABLE_ERROR event when there is an error in an IMAPITable::Sort, IMAPITable::Restrict, or IMAPITable::SetColumns method or when an underlying process attempts to update a table with, for example, new or modified rows.