IMAPIProp::DeleteProps
The IMAPIProp::DeleteProps
method deletes one or more properties.
Quick Info
See IMAPIProp
: IUnknown.
HRESULT DeleteProps(
|
LPSPropTagArray lpPropTagArray, |
|
|
LPSPropProblemArray FAR * lppProblems |
|
|
) |
|
Parameters
lpPropTagArray
[in] Pointer
to an array of property tags indicating the properties to delete. The cValues
member of the SPropTagArray
structure pointed to by lpPropTagArray must not be zero and the lpPropTagArray
parameter itself must not be NULL.
lppProblems
[in, out] On
input, can be NULL, indicating no need for error information, or a pointer to a
pointer to an SPropProblemArray structure. If lppProblems is a valid pointer on
input, DeleteProps returns detailed information about errors in deleting
one or more properties.
Return Values
S_OK
Properties
were successfully deleted.
MAPI_E_NO_ACCESS
The caller
has insufficient permissions to delete properties.
Remarks
The IMAPIProps::DeleteProps
method removes one or more properties from the current object.
Notes to Implementers
You do not
have to allow properties to be deleted from all objects. If the object is not
modifiable, return MAPI_E_NO_ACCESS from DeleteProps.
Notes to Callers
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.
Be aware that
some objects do not allow modification and that these objects return
MAPI_E_NO_ACCESS from DeleteProps. Other objects allow some properties
to be deleted, but not others. When there is a problem deleting only some of
the properties, DeleteProps returns S_OK. If you have passed a valid
pointer in the lppProblems parameter, DeleteProps will set it to
an SPropProblemArray structure containing detailed information about the
problems with each of the properties. For example, if you are deleting all of
the properties of a message and there is a problem with one or more of its
attachments, the SPropProblemArray structure will contain an entry for PR_MESSAGE_ATTACHMENTS.
The structure
pointed to by lppProblems is only valid if DeleteProps returns
S_OK. If DeleteProps returns an error, do not attempt to use the SPropProblemArray
structure. Instead, call the object s IMAPIProp::GetLastError method to get more
information about the error.
Free the
returned SPropProblemArray structure by calling the MAPIFreeBuffer function.
See Also