Contents Previous Page Next Page
RevokeFormatEnumerator

Removes a format enumerator from the given bind context.

HRESULT RevokeFormatEnumerator(

    LPBC 
pbc,                          //Pointer to the bind context                     
                                                                                         
    IEnumFORMATETC *pEFetc             //Pointer to the format enumerator to revoke      
                                                                                         
   );                                                                                    
                                                                                         

Parameters

pbc

[in] Pointer to the IBindCtx interface for the bind context from which the enumerator is to be revoked.

pbsc

[in] Pointer to the IEnumFORMATETC interface for the enumerator to revoke.

Return Values

S_OK

The enumerator was successfully removed..

E_INVALIDARG

One or more parameters are invalid.

Remarks

RevokeFormatEnumerator 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 IBindCtx::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 one chooses to reuse a bind context, one can use RevokeFormatEnumerator to remove a registered format enumerator so it is not re-used.

See Also

RegisterFormatEnumerator