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 and extended error codes of operations executed by the function block.

If detected errors are received in the response telegram from the agent, the outputs iq_stRequestInfo.q_stResponse.sOID and iq_stRequestInfo.q_stResponse.sAgentIp are still set with the data of the request that caused the error.

Enumeration Elements

Name

Data type

Value

Description

If q_xError of the function block is FALSE, the following status messages are shown:

Ok

UDINT

0

The operation was completed successfully and the function block is idle.

NotReady

UDINT

2

The requested operation cannot be executed in the present state.

Disabled

UDINT

3

The function block is disabled.

Sending

UDINT

4

The function block sends a request telegram with the information specified at the iq_stRequestInfo.i_stRequest input.

Listening

UDINT

5

The function block is waiting for a response from the agent.

Evaluating

UDINT

6

The function block is processing the received telegram.

If q_xError of the function block is TRUE, the following status messages are shown:

UnknownState

UDINT

1

The operation was not completed successfully due to an indeterminable error.

InitAsyncManagerUnsuccessful

UDINT

8

An internal error was detected while initializing the asynchronous manager.

AsyncTaskStartUnsuccessful

UDINT

9

An internal error was detected while starting the asynchronous task.

MaxNumberUserTooSmall

UDINT

13

The maximum number of user accounts is insufficient. The maximum number of user accounts is limited to 100.

MaxTelegramSize

UDINT

14

The maximum length of a telegram is exceeded. The maximum length of a telegram is limited to 2000 bytes.

GplMaxUserDataTooBig

UDINT

15

GPL.Gc_dwMaxSizeUserData is out of range.

Verify the settings of Global Parameter List.

GplMaxUserDataTooSmall

UDINT

16

GPL.Gc_dwMaxSizeUserData is out of range.

Verify the settings of Global Parameter List.

GplMaxOidTooBig

UDINT

17

GPL.Gc_dwMaxSizeOid is out of range.

Verify the settings of Global Parameter List.

GplMaxOidTooSmall

UDINT

18

GPL.Gc_dwMaxSizeOid is out of range.

Verify the settings of Global Parameter List.

GplTimeoutZero

UDINT

19

GPL.Gc_udiTimeout is out of range.

Verify the settings of Global Parameter List.

InputMissingOid

UDINT

20

The mandatory input iq_stRequestInfo.i_stRequest.sOid is invalid.

Verify that the input is assigned.

InputInvalidBufferSize

UDINT

21

The buffer must be larger than zero. The buffer size is provided by the value iq_stRequestInfo.i_stRequest.dwNumBytesValue.

InputInvalidRequest

UDINT

22

Only ET_SnmpRequest.GetRequest and ET_SnmpRequest.SetRequest are supported.

InputInvalidOid

UDINT

23

The OID must be provided as a STRING containing a sequence of numbers separated by dots. The first number must be 0,1, or 2.

InputInvalidIp

UDINT

24

The IP address is invalid. Verify that the IP address is provided as a STRING containing a sequence of 4 sets of numbers separated by dots. The values represented by the sets of numbers must be in the range of 0...255.

InputInvalidPointer

UDINT

25

The buffer referenced by the pointer iq_stRequestInfo.i_stRequest.pbyValueBuffer is invalid. Verify address of pointer referencing the buffer, the size of buffer and if it is writable.

InputSize32BitValue

UDINT

26

The data type referenced by iq_stRequestInfo.i_stRequest.etValueType allows values with a maximum size of 4 bytes.

InputSize64BitValue

UDINT

27

The data type referenced by iq_stRequestInfo.i_stRequest.etValueType allows values with maximum size of 8 bytes.

InputInvalidValueIp

UDINT

28

The data type referenced by iq_stRequestInfo.i_stRequest.etValueType requires a specified format: a STRING containing a sequence of 4 sets of numbers separated by dots. The values represented by the sets of numbers must be in the range 0...255.

InputInvalidValueOid

UDINT

29

The data type referenced by iq_stRequestInfo.i_stRequest.etValueType requires a specified format: a STRING containing a sequence of numbers separated by dots. The first number must be 0,1, or 2.

InputInvalidValueVersion

UDINT

30

The input data type i_etVersion of the function block FB_SnmpManager only allows the values Version1, Version2c or Version3.

UserNotFound

UDINT

31

A user account with the specified name is not found.

InputInvalidUserManagement

UDINT

32

If a user account is specified, i_ifUserManagement cannot be 0.

InvalidUserConfiguration

UDINT

33

The specified user account does not fulfill the requirements for the selected security level.

InputInvalidSecurityLevel

UDINT

34

The specified security level is invalid.

InputInvalidUser

UDINT

35

The user account specified for the configured security level is invalid.

UdpIssue

UDINT

40

Generic TCP issue. Refer to TcpUdpCommunication Library Guide.

UdpNotSupported

UDINT

41

The requested UDP operation is not supported by this controller.

UdpSocketMngListTooSmall

UDINT

42

The UDP socket could not be opened because the internal socket management list is full. GPL.Gc_uiSocketManagementListSize needs to be increased in TcpUdp library.

UdpNumBytesSendOutOfRange

UDINT

43

The number of bytes to send exceeds valid range. Contact your local Schneider Electric support.

UdpInvalidBufferAddress

UDINT

44

The address of the telegram buffer is invalid. Contact your local Schneider Electric support.

UdpInvalidIp

UDINT

45

The provided IP address is invalid. Verify the given input iq_stRequestInfo.i_stRequest. sAgentIp.

UdpReceiveBufferSizeOutOfRange

UDINT

46

The size of the receive buffer exceeds the valid range. Contact your local Schneider Electric support.

UdpNotReady

UDINT

47

The UDP request cannot be executed at the moment.

UdpTimeout

UDINT

48

No response received from the agent in the given time with the given retries. Try to increase GPL.Gc_udiTimeout and / or GPL.Gc_uiMaxNumberRetries.

ValidateRequestIdNoMatch

UDINT

60

The request ID received in response from the agent does not match the request ID sent to the agent. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP Address) and which OID provoked this message.

ValidateOidNoMatch

UDINT

61

The OID received in response from the agent does not match the requested OID. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

ValidateBufferTooSmall

UDINT

62

The provided buffer in iq_stRequestInfo.i_stRequest.pbyValueBuffer is insufficient for the value received from the agent. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP Address) and which OID provoked this message and the number of bytes received for the value.

NOTE: If the received value is of type ObjectId the decoded value is usually more than twice as large as the received number of bytes, plan buffer size accordingly.

ValidateVersionNotSupported

UDINT

63

The protocol version does not match in request/response.

ValidateAuthenticationUnsuccessful

UDINT

64

The response was not authenticated.

CorruptedResponse

UDINT

65

The response does not comply with the selected SNMP protocol.

ValidateMessageIdNoMatch

UDINT

66

The message ID of the response does not comply with the request.

ValidateNoValue

UDINT

69

The telegram received from the agent contained no value and no error message. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP Address) and which OID provoked this message.

SnmpResponseGenErr

UDINT

70

A generic error message received from an SNMP agent. There are no other errors detected. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseTooBig

UDINT

71

Response from an agent on a GET request or a SET request. The determined response message is too large for the agent to send. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetNoAccess

UDINT

72

Response from an agent on a SET request. Access was denied to requested OID. Verify community name in iq_stRequestInfo.i_stRequest.sCommunityName. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetWrongType

UDINT

73

Response from an agent on a SET request. The given value type does not match the type of the value specified by the OID. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetWrongLength

UDINT

74

Response from an agent on a SET request. The value length is inconsistent with defined length of OID value. Verify length of the OID value. If the error message persists contact your local Schneider Electric support. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetWrongEncoding

UDINT

75

Response from an agent on a SET request. Incorrect encoding was used for the value. Contact your local Schneider Electric support. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetWrongValue

UDINT

76

Response from an agent on a SET request. The given value for this OID is invalid or not supported. Verify input data in iq_stRequestInfo.i_stRequest. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetNotWritable

UDINT

77

Response from an agent on a SET request. The given value for this OID is invalid or not supported. Verify input data in iq_stRequestInfo.i_stRequest. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetNoSuchName

UDINT

78

Response from an agent on a SET request. The name is inconsistent or does not exist and could not be created. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetInconsistentValue

UDINT

79

Response from an agent on a SET request. The value could not be set or resource is not available to set this value. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseSetNoCreation

UDINT

80

Response from an agent on a SET request. The value does not exist and cannot be created. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseGetNoSuchObject

UDINT

81

Response from an agent on a GET request. The OID prefix does not match any OID prefix for accessible variables. Verify the OID in iq_stRequestInfo.i_stRequest.sOid. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseGetNoSuchInstance

UDINT

82

Response from an agent on a GET request. No exact match for the OID was found. Verify the OID in iq_stRequestInfo.i_stRequest.sOid. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseEndofMibView

UDINT

83

Response from an agent on a GET request. No further variables in lexicographical order. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

SnmpResponseV1WrongErrorState

UDINT

84

The responded value of ErrorState cannot be processed by the protocol version 1.

SnmpVersion1SetCounter64

UDINT

88

Counter64 is not available for SNMPv1.

ValueNotSupported

UDINT

90

Response from the agent contains an indeterminable value. Only value types provided by ET_SnmpTag are supported. Refer to iq_stRequestInfo.q_stResponse for information about which agent (IP address) and which OID provoked this message.

UnknownResult

UDINT

99

Feedback from FC_EtResultToString in the event of an indeterminable EtResult value.

EncryptionUnsuccessful

UDINT

110

An internal error was detected while encrypting / decrypting data.

InputInvalidKey

UDINT

111

The length of the key is beyond the allowed range of 1...64 bytes.

In the event of recurring timeouts and other communication errors, verify:

  • the physical connections of controller, SNMP agent, and so on.

  • the connection configuration of controller and SNMP agent.

  • the communication route between controller and SNMP agent. For example, switch and router settings, firewall settings (UDP communication and SNMP ports need to be allowed).

  • the provided IP address and SNMP port in iq_stRequestInfo.i_stRequest.

  • the provided community name in iq_stRequestInfo.i_stRequest.

Used By

  • FB_SnmpManager

  • FB_UserManagement