TCPIP_STACK_HeapHandleGet Function

C

TCPIP_STACK_HEAP_HANDLE TCPIP_STACK_HeapHandleGet(
    TCPIP_STACK_HEAP_TYPE heapType, 
    int heapIndex
);

Description

This function returns the current stack heap handle. It provides access to the heap statistics and monitoring functions.

Preconditions

None.

Parameters

ParametersDescription
heapTypeType of heap to request a handle for. Currently only one type of heap is supported at run time.
heapIndexIndex of the heap. Used when multiple heaps of the same type are created. Currently not used and it should be 0.

Returns

  • A handle to the current TCP/IP stack heap of the requested type.

  • 0 if an error occurred.

Remarks

None.