ET_Result

Overview

Type:

Enumeration

Available as of:

V1.0.9.0

Description

The enumeration ET_Result contains the possible values that indicate the result of operations executed by the function block.

Enumeration Elements

The values 0 to 99 are used to indicate the result of the operations executed by the function blocks FB_TCPClient/FB_TCPClient2, FB_TCPServer/FB_TCPServer2, and FB_UDPPeer.

Name

Value

Description

Ok

0

The operation completed successfully.

Failed

1

The operation was not completed successfully.

NotReady

10

The requested operation cannot be executed in the present state or the property Result was different than Ok prior to the function call.

NotSupported

11

The requested operation is not supported by this controller.

AddressInUse

12

The requested port address is already in use.

AddressNotAvailable

13

The requested IP address is not available since it is not configured on any Ethernet interface.

InputOutOfRange

20

The value is outside of the valid range.

ReceiveBufferSizeOutOfRange

21

The value of the input specifying the receive buffer size is outside of the valid range.

NumBytesToSendOutOfRange

22

The value of the input specifying the number of bytes to send is outside of the valid range.

FillLevelOutOfRange

23

The value of the input specifying the fill level of the buffer is outside of the valid range.

TooMuchOOBData

24

Only 1 byte of OutOfBand-data is allowed but a larger size was requested.

InvalidBufferAddress

25

The address of the buffer is invalid.

InvalidIP

26

The given IP address is not valid.

InvalidMulticastIP

27

The given IP address is not valid or not in the range of multicast addresses.

NoSuchClient

28

The client specified could not be found since it is not connected to the TCP server.

ClosedByPeer

40

The requested operation cannot be executed since the remote site has already closed the connection.

ConnectionTimedOut

41

The attempt to establish a connection has timed out because the remote system is not available or is not answering the request.

ConnectionRefused

42

The attempt to establish a connection is unsuccessful because the remote system denied it.

NotEnoughResources

50

The requested operation cannot be executed because there are not enough configurable internal resources available. Try using a smaller amount of data for one call.

SocketManagementListTooSmall

51

The socket cannot be opened since the size of the internal socket management list is insufficient. Close an already open socket or increase the value of Gc_uiSocketManagementListSize in the global parameter list (GPL).

ClientListTooSmall

52

The TCP server cannot have any more clients. Disconnect an existing client or increase the value of Gc_uiTCPServerMaxConnections in the global parameter list (GPL).

SendToAllSizeTooSmall

53

The requested number of bytes to send exceeds the limit. Reduce the amount of data to be sent or increase the value of Gc_udiTCPServerMaxSendToAllSize in the global parameter list (GPL).

BufferFull

54

The send buffer of the TCP stack is full, no more data can be copied. Increase send buffer size using the respective socket option or try to send again later.

CertificateNotFound

56

The specified certificate could not be found in the certificate store of the controller.

TlsError

57

Only available for FB_TcpServer2

The TLS (Transport Layer Security) handshake could not be completed. If the parameter etCertVerifyMode is set to AllCertificates or TrustedOnly, verify that the client sends a certificate and, if required, that it is categorized as trusted.

InitTlsContextFailed

58

Internal error detected while initializing the TLS context. Up to 10 different TLS contexts can be open at the same time. Ensure that not more than 10 TCP sockets using TLS are open at the same time.

InitAsyncManagerFailed

60

Internal error detected while initializing the async manager. The use of the async manager can be configured by the global variables GVL.G_xDisableAsyncExecTcpClient and GVL.G_xDisableAsyncExecTcpServer.

StartAsyncJobFailed

61

Internal error detected while starting the async job. The use of the async manager can be configured by the global variables GVL.G_xDisableAsyncExecTcpClient and GVL.G_xDisableAsyncExecTcpServer.

The values 1001 to 1100 are used to indicate the status of the function block FB_DnsClient. If q_xError of the function block is FALSE, one of the following status messages is provided through the q_etResult.

Name

Value

Description

Disabled

1001

The function block is disabled.

Initializing

1002

The function block is initializing.

Disabling

1003

The function block is disabling.

Ready

1004

The function block is ready.

SendDnsQuery

1010

The function block is sending query to DNS server.

WaitForDnsAnswer

1012

The function block is waiting for answer from DNS server.

AnalyzeDnsAnswer

1014

The function block is analyzing the answer.

The values 1500 to 1600 are used to indicate the operations executed by the function block FB_DnsClient. If q_xError of the function block is TRUE, one of the following error messages is provided through the q_etResult.

Name

Value

Description

InvalidDnsServerIP

1500

The specified IP address of the DNS server is invalid.

NOTE: i_sDnsServerIP must be something other than null and of the correct format.

InvalidDomainName

1502

No or invalid domain name specified.

OpenSocketFailed

1506

An error has been detected while opening an UDP socket.

SendDnsQueryFailed

1508

An error was detected while sending the query to the DNS server.

BufferSizeTooSmall

1510

Buffer size defined by GPL.Gc_udiDnsBufferSize is insufficient.

ReceiveDnsAnswerFailed

1512

An error was detected while receiving the data from the DNS server.

InvalidDnsAnswer

1514

DNS answer from server is invalid.

InvalidNumberOfIPs

1516

The value for the parameter GPL.Gc_udiDnsNumberOfIPs cannot be 0.

DnsResolutionFailed

1518

The DNS server could not resolve the requested domain name.

InternalError

1525

Internal error.

DnsServerError

1526

The DNS server response contained an error code. Refer to the output q_sResultMsg of the FB_DnsClient.

InvalidDnsTimeOut

1527

The value for the parameter GPL.Gc_timDnsTimeOut cannot be 0.

Used By

oFB_Dns_Client

oFB_TCPClient/FB_TCPClient2

oFB_TCPServer/FB_TCPServer2

oFB_UDPPeer

oFC_EtResultToString