Click or drag to resize

LayoutFieldSetString Method

Updates the string value of the index occurence of field in message.

Namespace:  OBCOM.NetSwitchLib.Layouts
Assembly:  OBCOM.NetSwitchLib (in OBCOM.NetSwitchLib.dll) Version: 1.48.7760.35650 (1.48.7760.35650)
Syntax
Copy
public virtual void SetString(
	LayoutMessage message,
	int index,
	string value
)

Parameters

message
Type: OBCOM.NetSwitchLib.LayoutsLayoutMessage
The message that will be updated.
index
Type: SystemInt32
The occurence index of the field.
value
Type: SystemString
The string representation of the field value.
Exceptions
ExceptionCondition
IndexOutOfRangeException If index is out of bounds.
Remarks

The value is interpreted and converted based on the field's type. The resulting value is then stored as a sequence of characters in the message.

If value is null then the field's data is set to NULL (see IsNull for more details).

See Also