IMAPISupport::ModifyStatusRow

The IMAPISupport::ModifyStatusRow method modifies the status table by adding a new row or modifying an existing row.

Quick Info

See IMAPISupport : IUnknown.

HRESULT ModifyStatusRow(
  ULONG cValues,               
  LPSPropValue lpColumnVals,   
  ULONG ulFlags                
);
 

Parameters

cValues

[in] Count of properties to be included in the new or modified status table row.

lpColumnVals

[in] Pointer to an array of property values describing the properties to be included as columns in the new or modified status table row.

ulFlags

[in] Bitmask of flags that controls how information defining the status table row is processed. The following flag can be set:

STATUSROW_UPDATE

Directs MAPI to merge the properties included in the array pointed to by lpColumnVals with an existing status table row rather than add them in a new row.

Return Values

S_OK

The status table was successfully updated.

Remarks

The IMAPISupport::ModifyStatusRow method is implemented for all service provider support objects. Service providers call ModifyStatusRow at logon time to add a row to the status table and at other times during the session to update the row. ModifyStatusRow provides MAPI with the information necessary to build the status table.

Notes to Callers

Set the STATUSROW_UPDATE flag when you call ModifyStatusRow to make changes to the properties in your existing status table row. Doing so informs MAPI that only the columns being changed are passed in the lpColumnVals parameter.

Clients can use the information in the status table to access your status object.

For a complete list of columns that you should include in your status table row, see Status Table.