CoRevokeMallocSpy (Compact 2013)
3/26/2014
This function revokes a registered IMallocSpy object.
Syntax
HRESULT CoRevokeMallocSpy( );
Parameters
None.
Return Value
- S_OK
The IMallocSpy object is successfully revoked.
- CO_E_OBJNOTREG
No spy is currently registered.
- E_ACCESSDENIED
Spy is registered but there are outstanding allocations (not yet freed) made while this spy was active.
Remarks
The IMallocSpy object is released when it is revoked. This release corresponds to the call to IUnknown::AddRef in the implementation of the QueryInterface function by the CoRegisterMallocSpy function. The implementation of the IMallocSpy interface should then do any appropriate cleanup.
If the return code is E_ACCESSDENIED, there are still outstanding allocations that were made while the spy was active. In this case, the registered spy cannot be revoked at this time because it may have attached arbitrary headers and/or trailers to these allocations that only the spy knows about.
Only the spy's PreFree (or PreRealloc) method knows how to account for these headers and trailers. Before returning E_ACCESSDENIED, CoRevokeMallocSpy notes internally that a revoke is pending.
When the outstanding allocations have been freed, the revoke proceeds automatically, releasing the IMallocSpy object. Thus, it is necessary to call CoRevokeMallocSpy only once for each call to CoRegisterMallocSpy, even if E_ACCESSDENIED is returned.
To determine whether the platform supports this function, see Determining Supported COM APIs.
Requirements
Header |
objbase.h |
Library |
ole32.lib |