rodbus.WriteResult Class Reference

Describes to the server if a write operation was successful or not. More...

Public Member Functions
WriteResult	WithSuccess (bool value)
	true if the operation was successful, false otherwise. Error details found in the exception field. More...
WriteResult	WithException (ModbusException value)
	Exception enumeration. If ModbusException.Unknown, look at the raw value More...
WriteResult	WithRawException (byte value)
	Raw exception value when WriteResult.Exception field is ModbusException.Unknown More...

Static Public Member Functions
static WriteResult	SuccessInit ()
	Initialize a WriteResult to indicate a successful write operation More...
static WriteResult	ExceptionInit (ModbusException exception)
	Initialize a WriteResult to indicate a standard Modbus exception More...
static WriteResult	RawExceptionInit (byte rawException)
	Initialize a WriteResult to indicate a non-standard Modbus exception More...

Public Attributes
bool	Success
	true if the operation was successful, false otherwise. Error details found in the exception field. More...
ModbusException	Exception
	Exception enumeration. If ModbusException.Unknown, look at the raw value More...
byte	RawException
	Raw exception value when WriteResult.Exception field is ModbusException.Unknown More...

Detailed Description

Describes to the server if a write operation was successful or not.

May either be 'success' or an exception code returned to the client.

Used in implementations of the IWriteHandler.

Member Function Documentation

ExceptionInit()

static WriteResult rodbus.WriteResult.ExceptionInit ( ModbusException  exception )

inlinestatic

Initialize a WriteResult to indicate a standard Modbus exception

Default values:

• WriteResult.Success: false
• WriteResult.RawException: 0

Parameters

exception

Exception enumeration. If ModbusException.Unknown, look at the raw value

Returns

Initialized WriteResult instance

RawExceptionInit()

static WriteResult rodbus.WriteResult.RawExceptionInit ( byte  rawException )

inlinestatic

Initialize a WriteResult to indicate a non-standard Modbus exception

Default values:

• WriteResult.Success: false
• WriteResult.Exception: ModbusException.Unknown

Parameters

rawException

Raw exception value when WriteResult.Exception field is ModbusException.Unknown

Returns

Initialized WriteResult instance

SuccessInit()

static WriteResult rodbus.WriteResult.SuccessInit ( )

inlinestatic

Initialize a WriteResult to indicate a successful write operation

Default values:

• WriteResult.Success: true
• WriteResult.Exception: ModbusException.Unknown
• WriteResult.RawException: 0

Returns

Initialized WriteResult instance

WithException()

WriteResult rodbus.WriteResult.WithException ( ModbusException  value )

inline

Exception enumeration. If ModbusException.Unknown, look at the raw value

WithRawException()

WriteResult rodbus.WriteResult.WithRawException ( byte  value )

inline

Raw exception value when WriteResult.Exception field is ModbusException.Unknown

WithSuccess()

WriteResult rodbus.WriteResult.WithSuccess ( bool  value )

inline

true if the operation was successful, false otherwise. Error details found in the exception field.

Member Data Documentation

Exception

ModbusException rodbus.WriteResult.Exception

Exception enumeration. If ModbusException.Unknown, look at the raw value

RawException

byte rodbus.WriteResult.RawException

Raw exception value when WriteResult.Exception field is ModbusException.Unknown

Success

bool rodbus.WriteResult.Success

true if the operation was successful, false otherwise. Error details found in the exception field.

---

The documentation for this class was generated from the following file:

• WriteResult.cs