RtnQueryStackHeapUsage

RtnQueryStackHeapUsage retrieves heap usage information for the TCP/IP Stack.

Syntax

BOOL RtnQueryStackHeapUsage(
    PULONG pUsedBytes,
    PULONG pRecycledBytes,
);

Parameters

pUsedBytes

A pointer to a ULONG to return the number of bytes allocated by the TCP/IP Stack.

pRecycledBytes

A pointer to a ULONG to return the number of bytes recycled by the TCP/IP Stack.

Return Value

Returns TRUE if the function succeeds, returns FALSE if the function fails. Call GetLastError for information on failure. The possible error codes are:

Error Code	Meaning
WSAEINVAL	The pointer argument is NULL.
WSASYSNOTREADY	The TCP/IP Stack has not initialized.

Remarks

When the TCP/IP Stack fails to allocate memory, it frees the recycled memory and attempts the allocation again.

Requirements

Minimum Supported Version	RTX64 4.0
Header	rtnapi.h
Library	RtTcpip.lib