Home > Support > NI Product Manuals > LabVIEW Communications System Design Suite 1.0 Manual

Scans a string for text that matches a specified format, returning these matches in the form of specified data types.


format string

A string that includes a format specifier for each output along with any additional text that you know appears in the input string but that you do not want to appear in an output. A format specifier is a series of characters, initiated by a %, that indicates how to convert a series of characters into an output.

Each format specifier uses the following general syntax:

% width specifier

This input accepts a maximum of 255 characters.


Syntax for Matching Literal Text That You Do Not Want To Output

Default: Empty string — Causes this node to scan the text according to the default behavior for the data types of the wired outputs.


input string

The string this node searches for data to format.


initial scan location

The number of characters into the string at which the scan begins.

Default: 0


error in

Error conditions that occur before this node runs. The node responds to this input according to standard error behavior.

Default: no error


default value

Default data type and default value for the corresponding output parameter. The node uses this information only if you do not wire a string constant to format string. If you do wire a string constant to format string, the node uses the format specifiers in that constant to determine the data type of each output.

Each default value can be a string, path, Boolean, enumerated type, timestamp, or numeric value. You cannot use arrays and clusters with this node.

Implications of Using an Enumerated Type

Default: 0, double-precision floating point or empty string, string, depending on the output data type defined by format string


remaining string

Portion of the string that remains after scanning all arguments.


offset past scan

The index in input string of the first character following the last scanned argument.


error out

Error information. The node produces this output according to standard error behavior.



Output data obtained from a single format specifier in format string.

The data type of this parameter matches the data type specified by the corresponding format specifier in format string or the corresponding default value. Possible data types include strings, paths, enumerated types, timestamps, and numerics, but not arrays and clusters. If you scan a string that does not fit into the numeric representation you specify, this node returns the largest number that fits into that representation.