RevokeFormatEnumerator Function

Removes a format enumerator from the given bind context.

Syntax

HRESULT RevokeFormatEnumerator(
    [in] LPBC pbc,
    [in] IEnumFORMATETC *pEFetc
);

Parameters

pbc

Address of the IBindCtx interface for the bind context from which the enumerator is to be revoked.

pEFetc

Address of the IEnumFORMATETC interface for the enumerator to revoke.

Return Value

Returns S_OK if the enumerator was successfully removed, or E_INVALIDARG if one or more parameters are invalid.

Remarks

This function removes a format enumerator from the bind context specified in pbc. It must previously have been registered with a call to RegisterFormatEnumerator.

Note that it is not necessary to make this call for every use of a bind context. It is possible (although not recommended) to reuse the same bind context and the same format enumerator for several bind operations. Upon calling IUnknown::Release, all registered objects on that bind context are revoked, including the format enumerator interfaces. Therefore, releasing a bind context implicitly releases all registered format enumerators. However, if you choose to reuse a bind context, you can use RevokeFormatEnumerator to remove a registered format enumerator so it is not reused.

Does this content meet your programming needs? Write us!

Back to top