Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
4/8/2010

The DeletePropsmethod deletes one or more properties.

Note:
Windows Mobile Messaging implements this method only for IAttachand IMessageinterface objects.

Syntax 

HRESULT DeleteProps (
  LPSPropTagArray 
lpPropTagArray,
  LPSPropProblemArray FAR * 
lppProblems
);

Parameters

lpPropTagArray

[in] Reference to an SPropTagArraystructure that is an array of property tags indicating the properties to delete; cannot be NULL.

lppProblems

[in] Ignored.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

S_OK

Indicates success.

MAPI_E_NO_ACCESS

The caller has insufficient permissions to delete properties.

MAPI_W_PARTIAL_COMPLETION

Not all properties were successfully deleted, but at least one property was successfully deleted.

Remarks

The cValuesmember of the SPropTagArraypointed to by lpPropTagArraymust not be zero.

You do not need to set the property type for each property tag in the property tag array pointed to by lpPropTagArray. Property types are ignored; only the property identifiers are used.

Some objects do not allow modification and return MAPI_E_NO_ACCESSfrom DeleteProps. Other objects allow some properties to be deleted but not others.

When DeletePropsis called from an IAttachinterface object, the following additional conditions must be true or the call will fail:

Copy Code 
lpPropTagArray->cValues == 1
lpPropTagArray->aulPropTag[0] == PR_ATTACH_DATA_BIN

Requirements

Header mapidefs.h
Library cemapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2002 and later, Smartphone 2002 and later

See Also