CreateFormatEnumerator function
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
- cfmtetc [in]
-
Number of FORMATETC structures in the static array specified by the rgfmtetc parameter. The cfmtetc parameter cannot be zero.
- rgfmtetc [in]
-
Pointer to a static array of FORMATETC structures.
- ppenumfmtetc [out]
-
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 |
|---|---|
|
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
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|