IMimeMessageTree::GetBodyOffsets method

Gets the offsets for the specified body.

Syntax

HRESULT GetBodyOffsets(
  [in]      HBODY         hBody,
  [in, out] LPBODYOFFSETS pOffsets
);

Parameters

hBody [in]

Type: HBODY

Specifies the handle of the body. Use HBODY_ROOT (0xffffffff) to indicate the root body.

pOffsets [in, out]

Type: LPBODYOFFSETS

Receives a pointer to the BODYOFFSETS structure for the specified body.

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 hBody or pOffsets is NULL.
MIME_E_NO_DATA	Indicates that hBody is equal to HBODY_ROOT (0xffffffff) and there is no root body.
MIME_E_INVALID_HANDLE	Indicates that hBody is an invalid handle.

Remarks

This method is equivalent to:

pMessageTree->BindToObject(hBody, IID_IMimeBody, (LPVOID *)&pBody);

pBody->GetOffsets(pOffsets);

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)