Share via


IMallocSpy::PreRealloc

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method is called just before invoking the IMalloc::Alloc method.

Syntax

ULONG PreRealloc(
  void* pRequest, 
  ULONG cbRequest, 
  void** ppNewRequest, 
  BOOL fSpyed 
);

Parameters

  • pRequest
    [in] Pointer specified in the original call to the IMalloc::Realloc method, indicating the memory block to be reallocated.
  • cbRequest
    [in] Memory block's byte count as specified in the original call to IMalloc::Realloc.
  • ppNewRequest
    [out] Address of pointer variable that receives a pointer to the actual memory block to be reallocated.

    This may be different from the pointer in pRequest if the implementation of IMallocSpy::PreRealloc extends or modifies the reallocation. This is an out pointer and should always be stored by PreRealloc.

  • fSpyed
    [in] TRUE if the original allocation was done while the spy was active, otherwise FALSE.

Return Value

The actual byte count to be passed to IMalloc::Realloc.

Remarks

The IMallocSpy::PreRealloc implementation may extend and/or modify the allocation to store debug-specific information with the allocation. Thus, the ppNewRequest parameter may differ from pRequest, a pointer to the request specified in the original call to IMalloc::Realloc.

PreRealloc can force memory allocation failure by returning zero, allowing testing to ensure that the application handles allocation failure gracefully in all cases.

In this case, PostRealloc is not called and Realloc returns NULL. However, if IMalloc::Realloc encounters a real memory failure and returns NULL, PostRealloc is called.

Forcing allocation failure is effective only if cbRequest is not equal to zero.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements

Header objidl.h, objidl.idl
Library ole32.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

CoRegisterMallocSpy
CoRevokeMallocSpy
IMalloc::Alloc
IMalloc::Realloc
IMallocSpy::PostRealloc