GetClientConnections (Method)

Overview

Type:

Method

Available as of:

V1.1.0.0

Description

The method GetClientConnections is used to obtain a list of connected clients. The list provides the IP address and the TCP port of each active client connection.

Interface

Inputs / Outputs

Data type

Description

iq_astConnectedClients

ARRAY [*] OF ST_ConnectedClients

The ARRAY of ST_ConnectedClients provides the buffer to store the information about active client connections.

Return Value

Data type

Description

ET_Result

The return value indicates the result of the method.

If the value is ET_Result.Ok, the execution of the method was completed successfully.

Troubleshooting

Return value

Possible cause

Solution

ET_Result.BufferTooSmall

The size of the ARRAY assigned to i_astConnectedClients is insufficient.

Increase the dimensions of the ARRAY to store the information about active client connections.