_CrtSetAllocHook

  • 项目

通过挂钩到 C 运行时调试内存分配进程安装客户端定义的分配函数（仅限调试版本）。

语法

_CRT_ALLOC_HOOK _CrtSetAllocHook(
   _CRT_ALLOC_HOOK allocHook
);

参数

allocHook
将新的客户端定义的分配函数挂钩到 C 运行时调试内存分配进程。

返回值

如果 allocHook 为NULL，则返回之前定义的分配挂钩函数或 NULL。

备注

_CrtSetAllocHook 允许应用程序将其自己的分配函数挂钩到 C 运行时调试库内存分配进程。 因此，每次调用调试分配函数以分配、重新分配或释放内存块时都会触发对应用程序挂钩函数的调用。 _CrtSetAllocHook 为应用程序提供了一种用于测试应用程序如何处理内存不足情况的简单方法，提供检查分配模式的功能以及记录分配信息以供以后分析的机会。 未定义 _DEBUG 时，会在预处理过程中删除对 _CrtSetAllocHook 的调用。

_CrtSetAllocHook 函数安装在 allocHook 中指定的新客户端定义的分配函数，并返回之前定义的挂钩函数。 以下示例演示了客户端定义的分配挂钩如何构建原型：

int YourAllocHook( int allocType, void *userData, size_t size,
                   int blockType, long requestNumber,
                   const unsigned char *filename, int lineNumber);

allocType 参数指定可触发分配的挂钩函数调用的分配操作类型（_HOOK_ALLOC、_HOOK_REALLOC 和 _HOOK_FREE）。 如果触发分配类型是 _HOOK_FREE，则 userData 是指向要释放的内存块的用户数据部分的指针。 但是，当触发分配类型为 _HOOK_ALLOC 或 _HOOK_REALLOC 时，userData 为 NULL，因为内存块尚未分配。

size 指定内存块的大小（以字节为单位），blockType 指示内存块的类型，requestNumber 是内存块的对象分配序号（如果存在），filename 和 lineNumber 指定启动触发分配操作的源文件名和行号。

挂钩函数处理完成后，必须返回一个布尔值，该值将告诉主 C 运行时分配进程如何继续。 如果挂钩函数想要主分配进程按挂钩函数从未被调用过的情况继续，那么挂钩函数应该返回 TRUE，这将导致执行原始触发分配操作。 挂钩函数可以收集和保存分配信息以用于以后分析，而不会干扰调试堆的当前分配操作或状态。

如果挂钩函数想要主分配进程按触发分配操作被调用且调用失败的情况继续，那么挂钩函数应返回 FALSE。 挂钩函数可以模拟大范围的内存条件和调试堆状态，以测试应用程序如何处理每种情况。

若要清除挂钩函数，请将 NULL 传递到 _CrtSetAllocHook。

若要详细了解 _CrtSetAllocHook 如何与其他内存管理函数一起使用，或如何编写自己的客户端定义的挂钩函数，请参阅编写调试挂钩函数。

注意

/clr:pure 下不支持 _CrtSetAllocHook。 /clr:pure 和 /clr:safe 编译器选项在 Visual Studio 2015 中已弃用，在 Visual Studio 2017 中已删除。

要求

例程 必需的标头
_CrtSetAllocHook <crtdbg.h>

有关兼容性的详细信息，请参阅 兼容性。

库

仅限 C 运行时库的调试版本。

示例

有关如何使用 _CrtSetAllocHook 的示例，请参阅 crt_dbg2。

另请参阅

调试例程
_CrtGetAllocHook