IMAPIProp_DeleteProps.3w

Langue: en

Version: Jun 2009 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

IMAPIProp_DeleteProps (MAPI32.@)

SYNOPSIS

static inline HRESULT IMAPIProp_DeleteProps
 (
  LPMAPIPROP           iface,
  LPSPropTagArray      lpTags,
  LPSPropProblemArray* lppProbs
 )

DESCRIPTION

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

Defined in "mapidefs.h".

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

Debug channel "mapi".