IMimeMessageW::GetPropW method

Gets a property value for the root header of the message.

Syntax

HRESULT GetPropW(
  [in]      LPCWSTR       pwszName,
  [in]      DWORD         dwFlags,
  [in, out] LPPROPVARIANT pValue
);

Parameters

pwszName [in]

Type: LPCWSTR

Specifies the property name or property ID.

dwFlags [in]

Type: DWORD

Specifies the bitmask that affects how to get the property value.

Value Meaning
PDF_ENCODED
The value of the property is encoded in an Internet character set and possibly RFC1522. Used in both getting and setting a property.
PDF_NAMEINDATA
The name of the property must be prefixed to the property value.
PDF_HEADERFORMAT
The value should be formatted according to RFC822 (character set encoded, wrapped, etc.).
PDF_NOCOMMENTS
Any comments embedded in the value must be stripped out.
PDF_SAVENOENCODE
When the header is saved, this value must not be re-encoded.
PDF_VECTOR
If the property appears multiple times, the values are concatenated together (separated by carriage return line feeds).

pValue [in, out]

Type: LPPROPVARIANT

Receives the value associated with the property. The client must initialize the pValue->vt member to a VARTYPE that is supported for the corresponding property. The client is responsible for freeing this PROPVARIANT structure by calling PropVariantClear or by freeing pointers by calling IMalloc::Free.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
Indicates success.
E_FAIL
Indicates that an unknown error has occurred.
E_INVALIDARG
Indicates that pwszName or pValue is NULL.
MIME_E_NOT_FOUND
Indicates that pwszName does not identify an existing property.
MIME_E_NO_DATA
Indicates that no data is associated with the property.
E_OUTOFMEMORY
Indicates that an attempt to allocate memory failed.
MIME_E_VARTYPE_NO_CONVERT
Indicates that the VARTYPE cannot be converted to the requested type.

Remarks

MIMEOLE supports these variant types: VT_LPSTR, VT_LPWSTR, VT_FILETIME, VT_UI4, VT_I4, and VT_STREAM.

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Product
Outlook Express 6.0
Header
Mimeole.h
IDL
Mimeole.idl
DLL
Inetcomm.dll (version 6.0 or later)