IMimeMessage::SetProp method

  • Article

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

Syntax

HRESULT SetProp(
  [in] LPCSTR         pszName,
  [in] DWORD          dwFlags,
  [in] LPCPROPVARIANT pValue
);

Parameters

pszName [in]

Type: LPCSTR

Specifies the property name or ID.

dwFlags [in]

Type: DWORD

Specifies a bitmask that affects how the property value is stored.

Value Meaning
PDF_ENCODED
 The value of the property is encoded in an Internet character set and possibly RFC 1522. 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 RFC 822 (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]

Type: LPCPROPVARIANT

Specifies the value to set for the property.

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_OUTOFMEMORY
 Indicates that an attempt to allocate memory failed.
E_INVALIDARG
 Indicates that pszName or pValue is NULL. Also may indicate that pValue->vt specifies a VARTYPE that is not supported or that its corresponding member in the PROPVARIANT structure is invalid, such as NULL pointer.
MIME_E_READ_ONLY
 Indicates that the property is read-only, that is, the property has the MPF_READONLY flag set in the property schema.
MIME_E_INVALID_HEADER_NAME
 Indicates that pszName is a new property that contains invalid characters.
MIME_E_NOT_FOUND
 Indicates that pszName specifies a property ID that does not exist in the property schema.

Remarks

A property ID can also be passed into this method through the pszName parameter using the PIDTOSTR macro.

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

This method is equivalent to:

pMessage->BindToObject(HBODY_ROOT, IID_IMimePropertySet, (LPVOID *)&pPropertySet);

pPropertySet->SetProp(pszName, dwFlags, pValue);

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)