RtfwtcpipGetClientProcessIDs

RtfwtcpipGetClientProcessIDs returns the IDs for all TCP-IP Stack client processes.

Syntax

Copy
bool RtfwtcpipGetClientProcessIDs(
    [out]    DWORD * pProcessIDs,
    [out]   size_t * pCountElements
);

Parameters

[out] pProcessIDs

A user-supplied array that will be filled in with the IDs currently using the TCP/IP Stack.

[out] pCountElements

The number of elements stored in parameter pProcessIDs.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError for additional error information.

Possible error codes:

Error Code Meaning

ERROR_INVALID_PARAMETER

A specified parameter value is not valid.

RT_ERROR_SUBSYSTEM_NOT_STARTED

The Subsystem is not started.

RT_ERROR_STACK_STOPPED

The TCP/IP Stack is stopped.

RT_ERROR_TIMEOUT_QUERYING_STACK_STATUS

A timeout occurred while querying for the status of the Stack.

RT_ERROR_TIMEOUT_QUERYING_STACK_CLIENT_PIDS

A timeout occurred while querying for the list of Stack client PIDs.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwtcpipApi.h

RtfwtcpipApi.lib