IPropData_DeleteProps(3w)

Usage

static HRESULT IPropData_DeleteProps
(
LPPROPDATA iface,
LPSPropTagArray lpTags,
LPSPropProblemArray* lppProbs
)

Overview

Delete one or more property values from an IMAPIProp object.

Params

iface [In] IMAPIProp object to remove property values from.

lpTags [In] Collection of property Id's to remove from iface.

lppProbs [Out] Destination for problems encountered, if any.

Returns

Success: S_OK. Any properties in iface matching property Id's in lpTags have been deleted. If lppProbs is non-NULL it contains details of any errors that occurred.

Failure: MAPI_E_INVALID_PARAMETER, if any parameter is invalid. E_ACCESSDENIED, if this object was created using CreateIProp(3w) and a subsequent call to IPropData_SetObjAcess(3w) was made specifying IPROP_READONLY as the access type.

Notes

- lppProbs will not be populated for cases where a property Id is present in lpTags but not in iface.

- lppProbs should be deleted with MAPIFreeBuffer(3w) if returned.

Implementation

Declared in "mapiutil.h".

Implemented in "dlls/mapi32/prop.c".

Debug channel "mapi".

Releases

4 releases since Debian 4.0 (Etch); the text changed 3 times.