Función HeapSetInformation (heapapi.h)

Habilita las características de un montón especificado.

Sintaxis

BOOL HeapSetInformation(
  [in, optional] HANDLE                 HeapHandle,
  [in]           HEAP_INFORMATION_CLASS HeapInformationClass,
  [in]           PVOID                  HeapInformation,
  [in]           SIZE_T                 HeapInformationLength
);

Parámetros

[in, optional] HeapHandle

Identificador del montón donde se va a establecer la información. Este identificador lo devuelve la función HeapCreate o GetProcessHeap .

[in] HeapInformationClass

Clase de información que se va a establecer. Este parámetro puede ser uno de los siguientes valores del tipo de enumeración HEAP_INFORMATION_CLASS .

[in] HeapInformation

Búfer de información del montón. El formato de estos datos depende del valor del parámetro HeapInformationClass .

Si el parámetro HeapInformationClass es HeapCompatibilityInformation, el parámetro HeapInformation es un puntero a una variable ULONG .

Si el parámetro HeapInformationClass es HeapEnableTerminationOnCorruption, el parámetro HeapInformation debe ser NULL y HeapInformationLength debe ser 0.

[in] HeapInformationLength

Tamaño del búfer HeapInformation , en bytes.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es 0 (cero). Para obtener información de error extendida, llame a GetLastError.

Comentarios

Para recuperar la configuración actual del montón, use la función HeapQueryInformation .

Se recomienda establecer la opción HeapEnableTerminateOnCorruption porque reduce la exposición de una aplicación a vulnerabilidades de seguridad que aprovechan un montón dañado.

Ejemplos

En el ejemplo siguiente se muestra cómo habilitar el montón de baja fragmentación.

#include <windows.h>
#include <tchar.h>
#include <stdio.h>

#define HEAP_LFH 2

int __cdecl _tmain()
{
    BOOL bResult;
    HANDLE hHeap;
    ULONG HeapInformation;

    //
    // Enable heap terminate-on-corruption. 
    // A correct application can continue to run even if this call fails, 
    // so it is safe to ignore the return value and call the function as follows:
    // (void)HeapSetInformation(NULL, HeapEnableTerminationOnCorruption, NULL, 0);
    // If the application requires heap terminate-on-corruption to be enabled, 
    // check the return value and exit on failure as shown in this example.
    //
    bResult = HeapSetInformation(NULL,
                                 HeapEnableTerminationOnCorruption,
                                 NULL,
                                 0);

    if (bResult != FALSE) {
        _tprintf(TEXT("Heap terminate-on-corruption has been enabled.\n"));
    }
    else {
        _tprintf(TEXT("Failed to enable heap terminate-on-corruption with LastError %d.\n"),
                 GetLastError());
        return 1;
    }

    //
    // Create a new heap with default parameters.
    //
    hHeap = HeapCreate(0, 0, 0);
    if (hHeap == NULL) {
        _tprintf(TEXT("Failed to create a new heap with LastError %d.\n"),
                 GetLastError());
        return 1;
    }

    //
    // Enable the low-fragmentation heap (LFH). Starting with Windows Vista, 
    // the LFH is enabled by default but this call does not cause an error.
    //
    HeapInformation = HEAP_LFH;
    bResult = HeapSetInformation(hHeap,
                                 HeapCompatibilityInformation,
                                 &HeapInformation,
                                 sizeof(HeapInformation));
    if (bResult != FALSE) {
        _tprintf(TEXT("The low-fragmentation heap has been enabled.\n"));
    }
    else {
        _tprintf(TEXT("Failed to enable the low-fragmentation heap with LastError %d.\n"),
                 GetLastError());
        return 1;
    }

    return 0;
}

Requisitos

Vea también

GetProcessHeap

Funciones del montón

MontónCrear

HeapQueryInformation

Funciones de administración de memoria