StringTokenizer.TreatConsecDelimAsOne Property

 Top 

Description

Determines whether consecutive delimiters will be treated as one delimiter or multiple.

 

For instance, if StringToParse is "A,B,,C", the Delimiters array contains a comma (",") as the sole delimiter, and TreatConsecDelimAsOne is set to 1, then the StringTokenizer object will parse out three tokens: "A", "B", and "C". Otherwise, the StringTokenizer will parse out four tokens: "A", "B", "", and "C". If two different delimiters (e.g. "," and ";") appear consecutively, these will be treated as two separate delimiters. So, if the StringToParse is "A,B,;C", this will always return 4 tokens.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Attributes

Type:

boolean

Access:

read/write

Default Value:

false

 

Syntax

myVariable1 = myStringTokenizer1.TreatConsecDelimAsOne;

 

myStringTokenizer1.TreatConsecDelimAsOne = myVariable1;

 

Example 1

This example demonstrates TreatConsecDelimAsOne set to true and set to false.

 

String myString = "A,B,,";

StringTokenizer myStringTokenizer;

 

myStringTokenizer.Delimiters[0] = ",";

myStringTokenizer.StringToParse = myString;

 

// When set to true, multiple delimiters in a row are treated as one delimiter

myStringTokenizer.TreatConsecDelimAsOne = 1;

Report myStringTokenizer.Tokens;

 

// When set to false, an empty string will be output for repeated delimiters

myStringTokenizer.TreatConsecDelimAsOne = 0;

Report myStringTokenizer.Tokens;

 

Output Report:

 

When set to 1:

 

{A,B}

 

When set to 0:

 

{A,B,}

 

 

See also

StringTokenizer Object

Parsing Arbitrary String Data