Share via

INNTPTransport::CommandXHDR method

  • Article

[INNTPTransport::CommandXHDR is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Issues an XHDR command to the server. This command can specify a range of messages or a single message to retrieve the header from. If pRange is NULL and pszMessageId is NULL the header is retrieved from the message pointed to by the server's current message pointer (see STAT, NEXT, LAST).

Syntax

HRESULT CommandXHDR(
  [in]           LPSTR   pszHeader,
  [in, optional] LPRANGE pRange,
  [in, optional] LPSTR   pszMessageId
);

Parameters

pszHeader [in]

Type: LPSTR

Which header to retrieve. IE "subject" or "xref"

pRange [in, optional]

Type: LPRANGE

Range of messages to retrieve the header from

pszMessageId [in, optional]

Type: LPSTR

Message ID of the message to retrieve the header from

Return value

Type: HRESULT

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

Requirements
Minimum supported client
 Windows XP [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Product
 Outlook Express 6.0
Header
Imnxport.h
IDL
Imnxport.idl
DLL
Inetcomm.dll (version 6.0 or later)