SetAttribIMsgOnIStg
The SetAttribIMsgOnIStg
function sets property attributes for properties of a particular object.
Quick Info
|
Header
file: |
IMESSAGE.H |
|
Implemented
by: |
MAPI |
|
Called by: |
Client
applications and message store providers |
HRESULT SetAttribIMsgOnIStg(
|
LPVOID lpObject, |
|
|
LPSPropTagArray lpPropTags, |
|
|
LPSPropAttrArray lpPropAttrs, |
|
|
LPSPropProblemArray FAR * lppPropProblems |
|
|
); |
|
Parameters
lpObject
[in] Pointer
to the object for which property attributes are being set.
lpPropTags
[in] Pointer
to an SPropTagArray
structure containing an array of property tags indicating the properties for
which property attributes are being set.
lpPropAttrs
[in] Pointer
to an SPropAttrArray
structure listing the property attributes to set.
lppPropProblems
[out] Pointer
to the returned SPropProblemArray structure containing a set of property
problems. This structure identifies problems encountered if SetAttribIMsgOnIStg
has been able to set some properties, but not all. If a pointer to NULL is
passed in the lppPropProblems parameter, no property problem array is
returned even if some properties were not set.
Return Values
S_OK
The call
succeeded and has returned the expected value or values.
MAPI_W_ERRORS_RETURNED
The call
succeeded overall, but one or more properties could not be accessed and were
returned with a property type of PT_ERROR.
Remarks
A message
store provider usually calls the SetAttribIMsgOnIStg function.
In the lpPropAttrs
parameter, the number and position of the attributes must match the number and
position of the property tags passed in the lpPropTags parameter.
The SetAttribIMsgOnIStg
function is used to make message properties read-only when required by the IMessage
schema. The sample message store provider uses it for this purpose. For more
information, see Messages.
See Also
GetAttribIMsgOnIStg