Enumerations

 

ET_Result

Overview

Type:

Enumeration

Available as of:

V1.0.0.0

Description

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

Enumeration Elements

Name

Data type

Value

Description

If q_xError of a function block is FALSE, the following status message is shown.

Ok

DINT

0

Operation completed successfully.

If q_xError of a function block is TRUE, one of the following status messages is shown.

TcpClientIssue

DINT

1

The TCP operation was not completed successfully. General TCP issue, refer to the TcpUdpCommunication Library Guide.

InvalidIP

DINT

26

The given IP address is not valid. Verify the setting of the iq_stConnSettings.wsGpIpAddress input.

ClientNotConnected

DINT

28

The client is not connected to the TCP server. Verify that the SQL Gateway is installed and running within the specified IP address and port.

ConnectionTimedOut

DINT

41

Remote system is not available or is not answering the request. Verify that the SQL Gateway is installed and running within the specified IP address and port.

DbConnectionNameNull

DINT

61

DbConnectionName is empty (Null). Element wsDbConnectionName from input iq_stConnSettings is blank.

DataBufferTooSmall

DINT

63

User buffer is insufficient for returning data. Matching the returning numbers of rows and columns with the settings in the global parameter list, you can find the minimum settings at q_uiRetNumOfRows (q_uiRetNumOfColumns) of FB_SqlDbRead after each execution.

SqlDatabaseBusy

DINT

64

A former request is currently being processed. Another instance with the same input for iq_stConnSettings is currently executed (output q_xBusy = TRUE).

SqlGwToPlcCorruptedMessage

DINT

65

Controller received an invalid message from the SQL Gateway. Contact your local Schneider Electric support.

TimeoutExpired

DINT

66

Function block operation timeout expired. Verify the setting of the input iq_stConnSettings.timSqlTimeout depending on the system configuration the default value must be increased.

TransactionNumMismatch

DINT

67

Transaction number mismatch. Contact your local Schneider Electric support.

TransmissionNumMismatch

DINT

68

Transmission number mismatch. Contact your local Schneider Electric support.

ConnectionNotIdle

DINT

69

TcpUdp client connection already occupied with another service.Verify that no other instance of TCPUDP.FB_TCPClient inside your application occupies the connection.

SocketNotClosed

DINT

70

Method Shutdown or Close from TcpUdp client not successful. TCP connection issue. Restart your controller.

NoDataReturned

DINT

71

The function block FB_SqlDbGetData does not provide any data. The SQL request was executed successfully but no data returned. Verify that the assigned database contains data.

NotConnected

DINT

72

TcpUdp client system is not ready to receive or transmit data. TCP connection issue. Restart your controller.

InvalidPort

DINT

80

 The given port number is equal to zero. Verify the iq_stConnSettings.wGwPort input. Usually, the default value 3457 is used.

InvalidWstringNumber

DINT

81

The input i_uiNumOfWstrings is less than 1 or greater than GPL.Gc_uiMaxRequest.

Verify the i_uiNumOfWstrings input. At least one WSTRING is required.

Also verify that the given number is greater than the limit GPL.Gc_uiMaxRequest (GPL).

InvalidRequestWstring

DINT

82

Empty request string or invalid reference (NULL). Verify the i_refRequestWstring input. The first WSTRING (i_refRequestWstring[1]) must contain any character. Verify that if the input is assigned.

InvalidUserDataWstring

DINT

83

Invalid user data reference (NULL). Verify that the i_refUserData input is assigned.

GplMaxRowsExceedsLimits

DINT

85

GPL.Gc_uiMaxRows is out of range. Verify the settings of Global Parameter List.

GplMaxColumnsExceedsLimits

DINT

86

GPL.Gc_uiMaxColumns is out of range. Verify the settings of Global Parameter List.

GplTableWstringExceedsLimits

DINT

87

GPL.Gc_uiTableWstringLength is out of range. Verify the settings of Global Parameter List.

GplRequestWstringExceedsLimits

DINT

88

GPL.Gc_uiRequestWstringLength is out of range. Verify the settings of Global Parameter List.

GplMaxRequestExceedsLimits

DINT

89

GPL.Gc_uiMaxRequest is out of range. Verify the settings of Global Parameter List.

GplMaxRecBufferExceedsLimits

DINT

91

GPL.Gc_uiRecBufferLength is out of range. Verify the settings of Global Parameter List.

GplMaxSendBufferExceedsLimits

DINT

92

GPL.Gc_uiSendBufferLength is out of range. Verify the settings of Global Parameter List.

ConnectionNameNotExisting

DINT

100

SQL Gateway connection name does not exist. Verify available database connections from SQL Gateway console.

DbConfigurationInvalid

DINT

101

SQL Gateway connection configuration does not match. Execute Test Database Connection from SQL Gateway console.

DbConnectionNotAvailable

DINT

102

SQL Gateway connection to the database does not work. Execute Test Database Connection from SQL Gateway console.

SqlGwProtocolError

DINT

120

Protocol error between SQL library and gateway detected. Contact your local Schneider Electric support.

CommandExecutionIssue

DINT

150

Execution of the SQL request not successful. Verify i_refRequestWString input according to the required SQL syntax. Refer to SQL server manual.

NoQueryResultAvailable

DINT

151

SQL Gateway does not provide an answer. Verify that the addressed database contains any data with an additional application.

SqlGwInvalidLicense

DINT

170

SQL Gateway license issue. Open the License Manager to verify that SQL for EcoStruxure Machine Expert is valid.

SqlGwUnexpectedError

DINT

199

SQL Gateway error detected. Contact your local Schneider Electric support.

NOTE: The results in the range 100...199 are messages from SQL Gateway. Refer to SQL Gateway User Guide.

Used By

oFB_SqlDbRead

oFB_SqlDbWrite