RegisterFormatEnumerator function

Registers a FORMATETC enumerator object on the given bind context.

Syntax

HRESULT RegisterFormatEnumerator(
  _In_       LPBC           pBC,
  _In_       IEnumFORMATETC *pEFetc,
  _Reserved_ DWORD          reserved
);

Parameters

• pBC [in]
  A pointer to the IBindCtx interface for the bind context on which to register the enumerator.

• pEFetc [in]
  A pointer to the IEnumFORMATETC interface for the enumerator to register.

• reserved [in]
  Reserved. Must be set to 0.

Return value

Returns S_OK if successful, or E_INVALIDARG if one or more parameters is invalid.

Remarks

The enumerator is used to determine the format types that are preferred for the bind operation. Typically, the pEFetc parameter is the pointer obtained through a call to CreateFormatEnumerator.

Requirements

See also

RevokeFormatEnumerator