LocalInfo

3.1

  #include <toolhelp.h>    

  BOOL LocalInfo(lpli, hglbHeap)    
  LOCALINFO FAR* lpli; /* address of LOCALINFO structure */
  HGLOBAL hglbHeap; /* handle of local heap */

The LocalInfo function fills the specified structure with information that describes the local heap.

Parameters

lpli

Points to a LOCALINFO structure that will receive information about the local heap. The LOCALINFO structure has the following form:

#include <toolhelp.h>

typedef struct tagLOCALINFO {  /* li */
    DWORD  dwSize;
    WORD   wcItems;
} LOCALINFO;

For a full description of this structure, see the Microsoft Windows Programmer's Reference, Volume 3.

hglbHeap

Identifies the local heap to be described.

Return Value

The return value is nonzero if the function is successful. Otherwise, it is zero.

Comments

The information in the LOCALINFO structure can be used to determine how much memory to allocate for a local heap walk.

Before calling LocalInfo, an application must initialize the LOCALINFO structure and specify its size, in bytes, in the dwSize member.

See Also

LocalFirst, LocalNext