 |
format string specifies how to convert the input string into the output arguments. The default is to scan the string according to the default format for the data types of the outputs. Formatting a time stamp as anything other than time returns an error. Right-click the function and select Edit Scan String from the shortcut menu to create and edit the format string.
A space in format string matches any amount of white space, such as spaces, tabs, linefeeds, and form feeds.
This input accepts a maximum of 255 characters.
|
|
input string is the string, path, enumerated type, time stamp, or numeric data to scan.
|
 |
initial scan location is the offset into the string where the scan begins. The default is 0.
|
 |
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
|
 |
default 1..n specifies the type and default value for the output parameters. If this function cannot scan the input value from format string, the function uses the default. If you do not wire default 1 and you wire a constant to format string, the function uses format string to determine the type of the output. Otherwise, the default data type is double-precision, floating-point. The default value is 0 or an empty string, depending on the output data type. If you wire an enumerated type to default 1, the function finds substrings matching the string values in the enumerated type and returns the corresponding numeric value of the enumerated type.
You can scan for Boolean values if you use a string or numeric format code. If the format code is %s or unwired, the function reads Y, T, TRUE, ON, or YES and any lowercase versions of those words as TRUE Boolean values. The function reads F, FALSE, OFF, or NO and any lowercase versions of those words as FALSE Boolean values. If you specify a numeric format code, the function reads any numeric value greater than 0.5 as TRUE and any numeric value less than or equal to 0.5 as FALSE.
 | Note This function reads negative numbers as FALSE Boolean values because the function converts the number to an unsigned 8-bit integer and any number less than or equal to 0.5 becomes 0 during the conversion. |
|
 |
remaining string returns the portion of the string that remains after scanning all arguments.
|
 |
offset past scan is the offset of input string after completing the scan.
|
 |
error out contains error information. This output provides standard error out functionality.
|
 |
output 1..n specifies the output parameters. Each output can be a string, path, enumerated type, time stamp, Boolean, or any numeric data type. If you scan a string that does not fit into the numeric data type you specify, this function returns the largest number that fits into that data type. You cannot use arrays and clusters with this function.
|
Add to the block diagram
Find on the palette