CoRegisterMallocSpy  A_DPUK

Registers an implementation of the IMallocSpy13UTFW2 interface in OLE, thereafter requiring OLE to call its wrapper methods around every call to the corresponding IMallocOCJ0KK method. IMallocSpy is defined in OLE to allow developers to debug memory allocations.

HRESULT CoRegisterMallocSpy(

Parameter

pMallocSpy

[in] Pointer to an instance of the IMallocSpy13UTFW2 implementation.

Return Values

This function supports the standard return value E_INVALIDARG, as well as the following:

S_OK

The IMallocSpy object is successfully registered.

CO_E_OBJISREG

There is already a registered spy.

Remarks

The CoRegisterMallocSpy function registers the IMallocSpy13UTFW2 object, which is used to debug calls to IMallocOCJ0KK methods. The function calls QueryInterface on the pointer pMallocSpy for the interface IID_IMallocSpy. This is to ensure that pMallocSpy really points to an implementation of IMallocSpy. By the rules of OLE, it is expected that a successful call to QueryInterface has added a reference (through the AddRef method) to the IMallocSpy object. That is, CoRegisterMallocSpy does not directly call AddRef on pMallocSpy, but fully expects that the QueryInterface call will.

When the IMallocSpy object is registered, whenever there is a call to one of the IMalloc methods, OLE first calls the corresponding IMallocSpy pre-method. Then, after executing the IMalloc method, OLE calls the corresponding IMallocSpy post-method. For example, whenever there is a call to IMalloc::Alloc, from whatever source, OLE calls IMallocSpy::PreAlloc, calls IMalloc::Alloc, and after that allocation is completed, calls IMallocSpy::PostAlloc.

See Also