_heapwalk

Artykuł
06/09/2015

Przechodzi sterty i zwraca informacje o następnym wpisie.

Ważne
Tego API nie można używać w aplikacjach korzystających ze środowiska wykonawczego systemu Windows z wyjątkiem kompilacji debugowania.Aby uzyskać więcej informacji, zobacz Funkcje CRT nieobsługiwane przez /ZW.

int _heapwalk( 
   _HEAPINFO *entryinfo 
);

Parametry

entryinfo
Bufor do przechowywania informacji stosu.

Wartość zwracana

_heapwalk zwraca jedną z następujących stałych całkowitych manifestu, określonych w Malloc.h.

_HEAPBADBEGIN
Informacje na temat początkowego nagłówka nieprawidłowe lub nie zostały znalezione.
_HEAPBADNODE
Znaleziono uszkodzoną stertę lub zły węzeł.
_HEAPBADPTR
Pole _pentry struktury _HEAPINFO nie zawiera prawidłowego wskaźnika do sterty lub entryinfo jest wskaźnikiem null.
_HEAPEND
Koniec sterty osiągnięty pomyślnie.
_HEAPEMPTY
Nie zainicjowano stosu.
_HEAPOK
Brak błędów do tej pory; entryinfo jest aktualizowana informacjami o następnej pozycji stosu.

Ponadto, jeśli wystąpi błąd _heapwalk ustawia errno jako ENOSYS.

Uwagi

_heapwalk funkcja pomaga debugować problemy związane ze stertą w programach.Funkcja przechodzi przez stertę, trawersując przez jeden zapis dla połączenia i zwraca wskaźnik do struktury typu _HEAPINFO , który zawiera informacje o następnej pozycji stosu._HEAPINFO typu, określony w Malloc.h, zawiera następujące elementy.

int *_pentry
Wskaźnik wejścia stosu.
size_t _size
Rozmiar zapisu sterty.
int _useflag
Flaga wskazująca, czy wpis stosu jest w użyciu.

Wywołanie _heapwalk , które zwraca _HEAPOK przechowuje rozmiar wpisu w polu _size i ustawia pole _useflag jako _FREEENTRY lub _USEDENTRY (obie to stałe zdefiniowane w Malloc.h).Aby uzyskać te informacje dotyczące pierwszej pozycji w stosie, należy przekazać _heapwalk wskaźnik do _HEAPINFO struktury, której _pentry element członkowski jest NULL.Jeżeli system operacyjny nie obsługuje _heapwalk(na przykład Windows 98), funkcja zwraca _HEAPEND i ustawia errno jako ENOSYS.

Ta funkcja sprawdza poprawność swojego parametru.Jeśli entryinfo jest pustym wskaźnikiem, zostanie wywołana procedura obsługi nieprawidłowego parametru, zgodnie z opisem w Sprawdzanie poprawności parametru.Jeśli wykonanie może być kontynuowane, errno jest ustawione jako EINVAL, a funkcja zwraca _HEAPBADPTR.

Wymagania

Procedura	Wymagany nagłówek	Opcjonalny nagłówek
_heapwalk	<malloc.h>	<errno.h>

Aby uzyskać więcej informacji na temat zgodności – zobacz: Zgodność.

Przykład

// crt_heapwalk.c

// This program "walks" the heap, starting
// at the beginning (_pentry = NULL). It prints out each
// heap entry's use, location, and size. It also prints
// out information about the overall state of the heap as
// soon as _heapwalk returns a value other than _HEAPOK
// or if the loop has iterated 100 times.

#include <stdio.h>
#include <malloc.h>

void heapdump(void);

int main(void)
{
    char *buffer;

    heapdump();
    if((buffer = (char *)malloc(59)) != NULL)
    {
        heapdump();
        free(buffer);
    }
    heapdump();
}

void heapdump(void)
{
    _HEAPINFO hinfo;
    int heapstatus;
    int numLoops;
    hinfo._pentry = NULL;
    numLoops = 0;
    while((heapstatus = _heapwalk(&hinfo)) == _HEAPOK &&
          numLoops < 100)
    {
        printf("%6s block at %Fp of size %4.4X\n",
               (hinfo._useflag == _USEDENTRY ? "USED" : "FREE"),
               hinfo._pentry, hinfo._size);
        numLoops++;
    }

    switch(heapstatus)
    {
    case _HEAPEMPTY:
        printf("OK - empty heap\n");
        break;
    case _HEAPEND:
        printf("OK - end of heap\n");
        break;
    case _HEAPBADPTR:
        printf("ERROR - bad pointer to heap\n");
        break;
    case _HEAPBADBEGIN:
        printf("ERROR - bad start of heap\n");
        break;
    case _HEAPBADNODE:
        printf("ERROR - bad node in heap\n");
        break;
    }
}