MimeOleGetBodyPropW function

  • Article

Do not use. Gets the value of a property for a specified body as Unicode.

Syntax

HRESULT MimeOleGetBodyPropW(
  _In_  IMimeMessageTree *pTree,
  _In_  HBODY            hBody,
  _In_  LPCSTR           pszName,
  _In_  DWORD            dwFlags,
  _Out_ LPWSTR           *ppszData
);

Parameters

pTree [in]

Type: IMimeMessageTree*

Specifies a pointer to the IMimeMessageTree object.

hBody [in]

Type: HBODY

Specifies the handle of the body.

pszName [in]

Type: LPCSTR

Specifies the property name or ID.

dwFlags [in]

Type: DWORD

Specifies a bitmask that affects how to get the property value. See GetBodyProp.

ppszData [out]

Type: LPWSTR*

Returns address of wide string into which property value is saved. Note: this variable must have been initialized to point to a valid LPWSTR before this call and user is responsible for freeing LPWSTR.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates success.
E_INVALIDARG
 Indicates that pTree is NULL.

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)