GetAttribIMsgOnIStg
The GetAttribIMsgOnIStg
function retrieves the attributes of the properties of a particular object.
Quick Info
|
Header
file: |
IMESSAGE.H |
|
Implemented
by: |
MAPI |
|
Called by: |
Client
applications and message store providers |
HRESULT GetAttribIMsgOnIStg(
|
LPVOID lpObject, |
|
|
LPSPropTagArray lpPropTagArray, |
|
|
LPSPropAttrArray FAR * lppPropAttrArray |
|
|
); |
|
Parameters
lpObject
[in] Obtained
from the OpenIMsgOnIStg
function, pointing to the object for which property attributes are being
retrieved.
lpPropTagArray
[in] Pointer
to an SPropTagArray
structure containing an array of property tags indicating the properties for
which attributes are being retrieved.
lppPropAttrArray
[out] Pointer
to a variable where the returned SPropAttrArray structure is stored. This SPropAttrArray
structure contains the retrieved property attributes.
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
The GetAttribIMsgOnIStg
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.
In the lppPropAttrArray
parameter the number and position of the attributes correspond to the number
and position of the property tags in the lpPropTagArray parameter.
See Also
IMAPIProp
: IUnknown, SetAttribIMsgOnIStg