OperationErrorCodes: Operation Error Codes

Enumerated Type Description

The OperationErrorCodes enumerated type contains codes that correspond to detected errors.

00

When the CommunicationErrorCodes is 00 hex (correct transaction), the OperationEr­rorCodes enumerated type can return these values:

Enumerator

Value (hex)

Description

OperationOK

00

The exchange is valid.

NotProcessed_or_TargetResourceMissing

01

The request has not been processed.

BadResponse

02

The received response is incorrect.

FF

When the CommunicationErrorCodes is FF hex (message refused), the OperationErrorCodes enumerated type can return these values:

Enumerator

Value (hex)

Description

NotProcessed_or_TargetResourceMissing

01

The target system resource is incommunicative.

BadLength

05

The length is incorrect.

CommChannelErr

06

The communication channel is associated with a detected error.

BadAddr

07

The address is incorrect.

SystemResourceMissing

0B

A system resource is unavailable.

TargetCommInactive

0C

A target communication function is not active.

TargetMissing

0D

The target is incommunicative.

ChannelNotConfigured

0F

The channel is not configured.

FE

When the CommunicationErrorCodes is FE hex, the OperationErrorCodes enumerated type can return these values:

Status name

Value (hex)

Description

Success

0x00

Service was successfully performed by the object specified.

Connection failure

0x01

A connection-related service is unsuccessful along the connection path.

Resource unavailable

0x02

Resources needed for the object to perform the requested service are unavailable

Invalid parameter value

0x03

See Status code 0x20, which is the preferred value to use for this condition.

Path segment error

0x04

The path segment identifier or the segment syntax was not understood by the processing node. Path processing shall stop when a path segment error is encountered.

Path destination unknown

0x05

The path is referencing an object class, instance, or structure element that is incorrect or is not contained in the processing node. Path processing stops when a this error is encountered.

Partial transfer

0x06

Only part of the expected data was transferred.

Connection lost

0x07

The messaging connection was lost.

Service not supported

0x08

The requested service is not implemented or is not defined for this object Class/Instance.

Invalid attribute value

0x09

Invalid attribute data.

Attribute list error

0x0A

An attribute in the Get_Attribute_List or Set_Attribute_List response has a non-zero status.

Already in requested mode/state

0x0B

The object is already in the mode/state being requested by the service.

Object state conflict

0x0C

The object cannot perform the requested service in its present mode/state.

Object already exists

0x0D

The requested instance of object to be created already exists.

Attribute not settable

0x0E

A request to modify a non-modifiable attribute was received.

Privilege violation

0x0F

A permission/privilege check is unsuccessful.

Device state conflict

0x10

The device mode/state does not allow the execution of the requested service.

Reply data too large

0x11

The data to be transmitted in the response buffer is larger than the allocated response buffer.

Fragmentation of a primitive value

0x12

The service specified an operation that is going to fragment a primitive data value, that is, half a REAL data type.

Not enough data

0x13

The service did not supply enough data to perform the specified operation.

Attribute not supported

0x14

The attribute specified in the request is not supported.

Too much data

0x15

The service supplied more data than was expected.

Object does not exist

0x16

The object specified does not exist in the device.

Service fragmentation sequence not in progress

0x17

The fragmentation sequence for this service is not active for this data.

No stored attribute data

0x18

The attribute data of this object was not saved prior to the requested service.

Store operation failure

0x19

The attribute data of this object was not saved.

Routing failure, request packet too large

0x1A

The service request packet was too large for transmission on a network in the path to the destination. The routing device was forced to abort the service.

Routing failure, response packet too large

0x1B

The service response packet was too large for transmission on a network in the path from the destination. The routing device was forced to end the service.

Missing attribute list entry data

0x1C

The service did not supply an attribute in a list of attributes that was needed by the service to perform the requested behavior.

Invalid attribute value list

0x1D

The service is returning the list of attributes supplied with status information for those attributes that were invalid.

Embedded service error

0x1E

An embedded service resulted in an error.

Vendor specific error

0x1F

A vendor specific error has been detected. The additional code field of the error response defines the particular error encountered. Use of this general error code should only be performed when none of the error codes presented in this table or within an object class definition accurately reflect the error.

Invalid parameter

0x20

A parameter associated with the request was invalid. This code is used when a parameter does not meet the requirements of this specification and/or the requirements defined in an application object specification.

Write-once value or medium already written

0x21

An attempt was made to write to a write-once medium (for example, WORM drive, PROM) that has already been written, or to modify a value that cannot be changed once established.

Invalid reply received

0x22

An invalid reply is received (for example, reply service code does not match the request service code, or reply message is shorter than the minimum expected reply size). This status code can serve for other causes of invalid replies.

Buffer overflow

0x23

The message received is larger than the receiving buffer can handle. The entire message is discarded.

Message format error

0x24

The format of the received message is not supported by the server.

Key failure in path

0x25

The Key segment that is included as the first segment in the path does not match the destination module. The object specific status indicates which part of the key check is unsuccessful.

Path size invalid

0x26

The size of the path which is sent with the Service request is either not sufficient to allow the request to be routed to an object, or too much routing data is included.

Unexpected attribute in list

0x27

An attempt was made to set an attribute that is not able to be set at this time.

Invalid member ID

0x28

The member ID specified in the request does not exist in the specified Class/Instance/Attribute.

Member not settable

0x29

A request to modify a non-modifiable member was received.

Group 2 only server general failure

0x2A

This error code may only be reported by Group 2 only servers with 4K or less code space and only in place of service not supported, attribute not supported and attribute not settable.

Unknown Modbus Error

0x2B

A CIP to Modbus translator received an invalid Modbus exception code.

Attribute not gettable

0x2C

A request to read a non-readable attribute is received.

Instance not deletable

0x2D

The requested object instance cannot be deleted.

Service not supported for specified path 1

0x2E

The object supports the service, but not for the designated application path (for example, attribute).

NOTE: Not to be used for any set service (use General status code 0x0E or 0x29 instead).

Timeout

0xFF

No response from the target.