PlcCharArray Members

Namespace: IPS7Lnk.Advanced
Assemblies: IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll
The PlcCharArray type exposes the following members.

PlcCharArray(PlcCharArrayType)

Initializes a new instance of the PlcCharArray class using the specified type.

C#

public PlcCharArray(PlcCharArrayType type)


Parameters

type PlcCharArrayType

The PlcCharArrayType of the new PlcCharArray to which the PLC array belongs.


Exceptions

ArgumentNullException

The type is a null reference (Nothing in Visual Basic).

PlcCharArray(PlcCharArrayType, Char[])

Initializes a new instance of the PlcCharArray class using the specified type and values.

C#

public PlcCharArray(PlcCharArrayType type, params char[] values)


Parameters

type PlcCharArrayType

The PlcCharArrayType of the new PlcCharArray to which the PLC array belongs.

values Char[]

The initial values of the new PlcCharArray.


Exceptions

ArgumentNullException

The type is a null reference (Nothing in Visual Basic).

PlcCharArray(PlcCharArrayType, PlcName, Char[])

Initializes a new instance of the PlcCharArray class using the specified type, name and values.

C#

public PlcCharArray(PlcCharArrayType type, PlcName name, params char[] values)


Parameters

type PlcCharArrayType

The PlcCharArrayType of the new PlcCharArray to which the PLC array belongs.

name PlcName

The name of the array represented.

values Char[]

The initial values of the new PlcCharArray.


Exceptions

ArgumentNullException

The type or name is a null reference (Nothing in Visual Basic).

PlcCharArray(PlcIdentity, Char[])

Initializes a new instance of the PlcCharArray class using the specified identity and values.

C#

public PlcCharArray(PlcIdentity identity, params char[] values)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcCharArray to which the PLC array belongs.

values Char[]

The initial values of the new PlcCharArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity is a null reference (Nothing in Visual Basic).

PlcCharArray(PlcIdentity, Int32)

Initializes a new instance of the PlcCharArray class using the specified identity and length.

C#

public PlcCharArray(PlcIdentity identity, int length)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcCharArray to which the PLC array belongs.

length Int32

The array length used to store the array values of the PlcCharArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.

PlcCharArray(PlcIdentity, PlcName, Char[])

Initializes a new instance of the PlcCharArray class using the specified identity, name and values.

C#

public PlcCharArray(PlcIdentity identity, PlcName name, params char[] values)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcCharArray to which the PLC array belongs.

name PlcName

The name of the array represented.

values Char[]

The initial values of the new PlcCharArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity or name is a null reference (Nothing in Visual Basic).

PlcCharArray(PlcIdentity, PlcName, Int32)

Initializes a new instance of the PlcCharArray class using the specified identity, name and length.

C#

public PlcCharArray(PlcIdentity identity, PlcName name, int length)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcCharArray to which the PLC array belongs.

name PlcName

The name of the array represented.

length Int32

The array length used to store the array values of the PlcCharArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity or name is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.

GetElementCore(Int32)

Retrieves the PlcChar at the specified index.

C#

protected override PlcChar GetElementCore(int index)


Parameters

index Int32

The zero-based index of the element to get.


Returns

PlcChar

The PlcChar at the specified index.

GetValueCore(PlcDeviceConnection)

Retrieves the current value of the PLC value from a IPlcDevice using the connection specified.

C#

protected override char[] GetValueCore(PlcDeviceConnection connection)


Parameters

connection PlcDeviceConnection

The PlcDeviceConnection from that the data is to be retrieved.


Returns

Char[]

The current value of the PLC value.



Exceptions

InvalidOperationException

The connection is in Faulted state and cannot longer be opened.

ObjectDisposedException

The connection has been disposed of.

RelocateCore(PlcAddress)

Relocates the value to the address specified.

C#

protected override IPlcValue RelocateCore(PlcAddress address)


Parameters

address PlcAddress

The PlcAddress to that the value is to be relocated.


Returns

IPlcValue

A new instance of the same type as this PLC value instance relocated to the address specified.

SetValueCore(PlcDeviceConnection, Char[])

Stores the value in the IPlcDevice assigned to the connection specified.

C#

protected override void SetValueCore(PlcDeviceConnection connection, char[] value)


Parameters

connection PlcDeviceConnection

The PlcDeviceConnection to use to store the value.

value Char[]

The value to be stored.



Exceptions

InvalidOperationException

The connection is in Faulted state and cannot longer be opened.

ObjectDisposedException

The connection has been disposed of.