Click or drag to resize

LayoutMessageGetString Method (String, Int32)

Returns the string value of the field identified by name and index.

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

Parameters

name
Type: SystemString
The name of the field.
index
Type: SystemInt32
The occurence index of the field.

Return Value

Type: String
The string value of the field identified by name and index. It returns null if the string data starts with the special character NO-DATA (0x1A).
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 the field is a LIST and the value of index is -1, this method returns a string containing all the occurrences of the list.

The trailing spaces of the string are removed (right trim).

See Also