Microsoft DirectX 8.1 (C++)

ICATolls::get__NewEnum

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The get__NewEnum method retrieves an enumerator for the collection.

Syntax

HRESULT get__NewEnum(
  IUnknown**  ppCollection
);

Parameters

  ppCollection

[out]  Pointer to a variable that receives an IUnknown interface pointer.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The returned enumerator supports the IEnumVARIANT interface. The enumerator is thread-safe; this method clones the list of elements in the collection, so the list will not reflect changes to the collection made by other threads.

If the method succeeds, the IUnknown interface has an outstanding reference count. The caller must release the interface.

See Also