PlcStringInfo Members

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

C#

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

Parameters

identity PlcIdentity

The PlcIdentity of the type of value member.

name PlcName

The name of the value member.

length Int32

The length of the value member.

Exceptions

ArgumentException

The identity does not refer to the Byte or name is equal to Empty.

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.

Initializes a new instance of the PlcStringInfo class using the specified identity, name and initialValue.

C#

public PlcStringInfo(PlcIdentity identity, PlcName name, string initialValue)

Parameters

identity PlcIdentity

The PlcIdentity of the type of value member.

name PlcName

The name of the value member.

initialValue String

The initial value of the member.

Exceptions

ArgumentException

The identity does not refer to the Byte or name is equal to Empty.

ArgumentNullException

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

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

C#

public PlcStringInfo(PlcIdentity identity, PlcName name, string initialValue, int length)

Parameters

identity PlcIdentity

The PlcIdentity of the type of value member.

name PlcName

The name of the value member.

initialValue String

The initial value of the member.

length Int32

The length of the value field.

Exceptions

ArgumentException

The identity does not refer to the Byte or name is equal to Empty.

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.

Initializes a new instance of the PlcStringInfo class using the specified name and length.

C#

public PlcStringInfo(PlcName name, int length)

Parameters

name PlcName

The name of the value member.

length Int32

The length of the value member.

Exceptions

ArgumentException

The name is equal to Empty.

ArgumentNullException

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

ArgumentOutOfRangeException

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

Initializes a new instance of the PlcStringInfo class using the specified name and initialValue.

C#

public PlcStringInfo(PlcName name, string initialValue)

Parameters

name PlcName

The name of the value member.

initialValue String

The initial value of the member.

Exceptions

ArgumentException

The name is equal to Empty.

ArgumentNullException

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

Initializes a new instance of the PlcStringInfo class using the specified name, initialValue and length.

C#

public PlcStringInfo(PlcName name, string initialValue, int length)

Parameters

name PlcName

The name of the value member.

initialValue String

The initial value of the member.

length Int32

The length of the value field.

Exceptions

ArgumentException

The name is equal to Empty.

ArgumentNullException

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

ArgumentOutOfRangeException

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

Initializes a new instance of the PlcStringInfo class using the specified type and name.

C#

public PlcStringInfo(PlcStringType type, PlcName name)

Parameters

type PlcStringType

The type of value member.

name PlcName

The name of the value member.

Exceptions

ArgumentNullException

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

Initializes a new instance of the PlcStringInfo class using the specified type, name and initialValue.

C#

public PlcStringInfo(PlcStringType type, PlcName name, string initialValue)

Parameters

type PlcStringType

The type of value member.

name PlcName

The name of the value member.

initialValue String

The initial value of the new PlcStringInfo.

Exceptions

ArgumentNullException

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

Gets a 32-bit integer that represents the maximum number of characters that can be stored.

C#

public int Length { get; }

Property Value

Int32

A 32-bit integer that represents the maximum number of characters that can be stored.

Retrieves the PlcStringInfo as an absolute addressable PLC data member.

C#

public override IPlcMemberInfo MakeAbsoluteMember(PlcIdentity identity)

Parameters

identity PlcIdentity

The PlcIdentity to use to define the absolute location. This identity is used to define the basis starting from that the member is be located.

Returns

IPlcMemberInfo

In case there IsAbsolute is equals true the reference to this member; otherwise a new instance of the member which refers to an absolute PlcType.

Exceptions

ArgumentException

The identity specified does not provide the necessary information required to address the type of data.

ArgumentNullException

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

Relocates the member to the type specified.

C#

protected override PlcMemberInfo RelocateCore(PlcType type)

Parameters

type PlcType

The PlcType to that the member is to be relocated.

Returns

PlcMemberInfo

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

Retrieves the string representation of the PlcStringInfo.

C#

public override string ToString()

Returns

String

The string representation of the PlcStringInfo.