Share via

MimeOleGetRelatedSection function

  • Article

Do not use. Returns handle to the first body in the message tree that has the related content type. Also returns whether other instances were found. If related content type is not found, method argument specifies whether it should be created.

Syntax

HRESULT MimeOleGetRelatedSection(
  _In_  IMimeMessageTree *pTree,
  _In_  boolean          fCreate,
  _Out_ LPHBODY          phRelated,
  _Out_ boolean          *pfMultiple
);

Parameters

pTree [in]

Type: IMimeMessageTree*

Specifies a pointer to the IMimeMessageTree object.

fCreate [in]

Type: boolean

Specifies whether to create section if not found.

phRelated [out]

Type: LPHBODY

Receives handle of the related body section.

pfMultiple [out]

Type: boolean*

Returns whether there were multiple/related body parts.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates success.
E_INVALIDARG
 Indicates that pTree is NULL.
MIME_E_NOT_FOUND
 Indicates that content type neither found nor created.

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)