Edit

CreateFormatEnumerator function (urlmon.h)

  • Article

Creates an object that implements IEnumFORMATETC over a static array of FORMATETC structures.

Syntax

HRESULT CreateFormatEnumerator(
  [in]  UINT           cfmtetc,
  [in]  FORMATETC      *rgfmtetc,
  [out] IEnumFORMATETC **ppenumfmtetc
);

Parameters

[in] cfmtetc

Number of FORMATETC structures in the static array specified by the rgfmtetc parameter. The cfmtetc parameter cannot be zero.

[in] rgfmtetc

Pointer to a static array of FORMATETC structures.

[out] ppenumfmtetc

Address of IEnumFORMATETC pointer variable that receives the interface pointer to the enumerator object.

Return value

This function returns S_OK on success. Other possible return values include the following.

Return code Description
E_INVALIDARG
One or more parameters are invalid.

Remarks

The CreateFormatEnumerator function creates an enumerator object that implements IEnumFORMATETC over a static array of FORMATETC structures. The cfmtetc parameter specifies the number of these structures. With the pointer, you can call the standard enumeration methods to enumerate the structures.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header urlmon.h
Library Urlmon.lib
DLL Urlmon.dll