IMimeHeaderTable::EnumRows method

  • Article

Creates an enumerator object for enumerating the rows in the header table object.

Syntax

HRESULT EnumRows(
  [in]  LPCSTR              pszHeader,
  [in]  DWORD               dwFlags,
  [out] IMimeEnumHeaderRows **ppEnum
);

Parameters

pszHeader [in]

Type: LPCSTR

Specifies an LPCSTR that contains a string to compare header names against. Only rows whose header names match this value are enumerated. All rows are enumerated when this parameter is NULL.

dwFlags [in]

Type: DWORD

Specifies a bitmask that indicates the type of data to return.

Value Meaning
HTF_ENUMHANDLESONLY
 Indicates that only rows handles (no data) should be returned in the enumeration.

ppEnum [out]

Type: IMimeEnumHeaderRows**

Receives the address of a pointer to a IMimeEnumHeaderRows object.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates success.
E_INVALIDARG
 Indicates that ppEnum is NULL.
E_OUTOFMEMORY
 Indicates that an attempt to allocate memory failed.

Remarks

Rows are enumerated in the order in which they would appear in a saved header.

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)