MimeOleDecodeHeader function

Article
05/31/2018

Do not use. Decodes a message header string.

Syntax

HRESULT MimeOleDecodeHeader(
  _In_    HCHARSET      hCharset,
  _In_    LPCSTR        pszData,
  _Out_   LPPROPVARIANT pDecoded,
  _Inout_ LPRFC1522INFO pRfc1522Info
);

Parameters

hCharset [in]

Type: HCHARSET

Specifies the handle of the character set to use to decode the header text.

pszData [in]

Type: LPCSTR

Specifies an LPCSTR that contains the header to decode.

pDecoded [out]

Type: LPPROPVARIANT

Receives a pointer to the PROPVARIANT structure that contains the decoded header.

pRfc1522Info [in, out]

Type: LPRFC1522INFO

Receives a pointer to the RFC1522INFO structure that contains RFC 1522 encoding information for the header.

Return value

Type: HRESULT

Returns one of the following values.

Return code	Description
S_OK	Indicates success.
MIME_E_INVALID_HANDLE	Indicates that hCharset is an invalid handle.
E_FAIL	Indicates that hCharset is NULL and that an appropriate character set in which to decode the header cannot be identified.
MIME_S_NO_CHARSET_CONVERT	Indicates that a character set conversion failed or was not performed on the header.
E_OUTOFMEMORY	Indicates that an attempt to allocate memory failed.
E_INVALIDARG	Indicates that pszData or pDecoded is NULL or that pDecoded->vt is not equal to VT_LPSTR ro VT_LPWSTR.

Remarks

See DecodeHeader for more information.

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
Library	Inetcomm.lib
DLL	Inetcomm.dll (version 6.0 or later)