Edit

IItemPreviewerExt::GetRelatedPart method

  • Article

Gets a related body part for embedding into the output MHTML stream.

Syntax

HRESULT GetRelatedPart(
  [in]          DWORD     dwContext,
  [in]          LPCOLESTR pwszProp,
  [in]          DWORD     dwIndex,
  [out, retval] LINKINFO  *pInfo
);

Parameters

dwContext [in]

Type: DWORD

The context identifier for the operation. Override the dwContext default to set the context identifier to a value of your choosing.

pwszProp [in]

Type: LPCOLESTR

A pointer to the property of the linked content as a Unicode string.

dwIndex [in]

Type: DWORD

An unsigned long integer value that contains the zero-based index of the related body part.

pInfo [out, retval]

Type: LINKINFO*

Receives a pointer to the LINKINFO structure in which the method returns information about the transaction. pInfo must not be a NULL pointer.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The IItemPreviewerExt interface is supported only on Windows XP and Windows Server 2003, and should no longer be used.

To preview attachments with a third-party protocol handler on computers running Windows XP or Windows Server 2003, it may be necessary to use the IItemPreviewerExt interface, and the following APIs: the ISearchProtocolUI, IItemPropertyBag and ISearchItem interfaces, the LINKINFO structure, and the LINKTYPE enumeration.

Requirements

Requirement Value
Minimum supported client
 Windows XP with SP2 [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Redistributable
 Windows Desktop Search (WDS) 3.0

See also

IItemPreviewerExt