Click or drag to resize

LayoutMessageSetString Method (String, Int32, String)

Changes the string value of the field identified by name and index to the supplied value.

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

Parameters

name
Type: SystemString
The name of the field.
index
Type: SystemInt32
The occurence index of the field.
value
Type: SystemString
The new string value of the field.
Exceptions
ExceptionCondition
InvalidOperationException If this LayoutMessage has no Layout, or if the required field is not defined in the Layout of this LayoutMessage.
IndexOutOfRangeException If index is less than "0" (zero) or greater-equal to the number of occurrences of the field, as indicated by the Occurs property.
Remarks
If value is null the sequence is filled with the special character NO-DATA (0x1A).

If the field is a LIST and the value of index is -1, this method updates the string value of all the occurrences of the list. This functionality is specially useful when value is either null or "" (an Empty String).

See Also