IMimePropertySet::GetOption method

Gets the value of an option.

Syntax

HRESULT GetOption(
  [in]      const TYPEDID       oid,
  [in, out]       LPPROPVARIANT pValue
);

Parameters

oid [in]

Type: const TYPEDID

Specifies the option ID.

Value Meaning
OID_HEADER_RELOAD_TYPE
VT_UI4 that indicates how the IMimePropertySet resets itself when IMimePropertySet::Load and IMimePropertySetInitNew are called consecutively. Using this option, a client can load and merge multiple headers into the same object. Valid values for this option are defined by RELOADTYPE. The default value is RELOAD_HEADER_NONE.
OID_NO_DEFAULT_CNTTYPE
VT_BOOL that indicates whether MimeOLE should default the Content-Type to text/plain when IMimePropertySet::Save is called and there is no Content-Type header.
FALSE
Default. MimeOLE should set the Content-Type to text/plain.
TRUE
MimeOLE should not set the Content-Type.
OID_ALLOW_8BIT_HEADER
VT_BOOL that indicates whether to allow 8-bit characters to be saved in the header. This option also indicates whether to allow RFC 1522 encoding.
FALSE
Default. Disallow 8-bit characters and RFC 1522 encoding.
TRUE
Allow 8-bit characters and RFC 1522 encoding.
OID_CBMAX_HEADER_LINE
VT_UI4 that indicates the maximum number of characters for a line when the property set is saved. Headers longer than this length are wrapped. The minimum value for this option is 76 and the maximum is 0xffffffff (no limit). The default value is 1000.
OID_SAVE_FORMAT
VT_UI4 that indicates the header should be saved in RFC 822 or RFC 1521 (MIME) format. The default value is SAVE_RFC1521.

pValue [in, out]

Type: LPPROPVARIANT

Receives a pointer to a PROPVARIANT structure that contains the value for the option. MimeOLE sets pValue->vt and the corresponding member in this structure according to the VARTYPE of the option.

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 pValue is NULL.
MIME_E_INVALID_OPTION_ID
Indicates that oid is not a valid IMimePropertySet option.

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)