IMAPIProp::DeleteProps

  • Article

4/8/2010

The DeleteProps method deletes one or more properties.

Note

Windows Mobile Messaging implements this method only for IAttach and IMessage interface objects.

Syntax

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

Parameters

  • lpPropTagArray
    [in] Reference to an SPropTagArray structure 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 cValues member of the SPropTagArray pointed to by lpPropTagArray must 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_ACCESS from DeleteProps. Other objects allow some properties to be deleted but not others.

When DeleteProps is called from an IAttach interface object, the following additional conditions must be true or the call will fail:

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

Reference

IMAPIProp
IMAPIProp::GetProps
MAPIFreeBuffer
SPropTagArray

Other Resources

Messaging