RevokeFormatEnumerator function

Article
07/13/2016

Removes a format enumerator from the given bind context.

Syntax

HRESULT RevokeFormatEnumerator(
  _In_ LPBC           pbc,
  _In_ IEnumFORMATETC *pEFetc
);

Parameters

pbc [in]
The address of the IBindCtx interface for the bind context from which the enumerator is to be revoked.
pEFetc [in]
The address of the IEnumFORMATETC interface for the enumerator to revoke.

Return value

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

Remarks

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

Note You don't have to make this call for every use of a bind context. Although it is not recommended it is possible to reuse the same bind context and the same format enumerator for several bind operations. After the Release method is called, all registered objects on that bind context are revoked, including the format enumerator interfaces. Releasing a bind context implicitly releases all registered format enumerators. If you want to reuse a bind context, you can use RevokeFormatEnumerator to remove a registered format enumerator so that it is not reused.

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows 2000 Server
Product	Internet Explorer 3.0
Header	Urlmon.h
Library	Urlmon.lib
DLL	Urlmon.dll

Partager via