FileInterface.Get(Variable, String) Method

Top 

Description

Extracts the number of characters specified by lengthVariable from the stream, stopping the stream early if the delimiter specified by delimiterString is found.

 

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.

 

Method Signature

FileInterface.Get(

Variable lengthVariable,


String delimiterString)

 

 

Arguments

lengthVariable


Description:

Variable that specifies the number of characters to extract from the file stream.

 

 

delimiterString


Description:

String that specifies the delimiter used to stop the extraction of characters from the file stream.

 

 

 

Return Value

Type:

string

 

 

Returns a String containing the characters extracted from the stream.

 

Syntax

myString1 = myFileInterface1.Get(myVariable1, myString2);

 

 

See also

FileInterface Object

FileInterface.Get

Interfacing with Files Guide

Parsing Arbitrary String Data