IStoreFolder::GetMessageProps method
Gets properties of a specified message.
Syntax
HRESULT GetMessageProps(
[in] MESSAGEID dwMessageId,
[in] DWORD dwFlags,
[in, out] LPMESSAGEPROPS pProps
);
Parameters
-
dwMessageId [in]
-
Type: MESSAGEID
Specifies the message for which properties will be retrieved.
-
dwFlags [in]
-
Type: DWORD
Flags that determine how the operation will be performed. Set to 0 to retrieve all properties of the specified message. Set to MSGPROPS_FAST to expedite retrieval and return a limited set of message information.
-
pProps [in, out]
-
Type: LPMESSAGEPROPS
Pointer to a MESSAGEPROPS structure that receives the properties for the specified message.
Return value
Type: HRESULT
Returns S_OK if successful, or one of the following error values.
| Return code | Description |
|---|---|
|
The value of dwMessageId is invalid, or the pProps parameter is NULL. |
|
The message referenced by dwMessageId was not found. |
Remarks
If dwFlags is set to MSGPROPS_FAST, only the following members of the structure referenced by the pProps structure will be valid.
- cbSize
- dwReserved
- dwMessageId
- dwLanguage
- dwState
The MESSAGEPROPS structure that is received by the pProps parameter must be freed after use using the IStoreFolder::FreeMessageProps method.
Requirements
| Minimum supported client |
Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| Product |
Outlook Express 6.0 |
| Header |
|
| IDL |
|
| DLL |
|