StkPatternFileReadFrom Method (String, StkPatternFileOptions)

Reads an STK pattern (.pattern) file from a file. See the Remarks section of the documentation of ReadFrom(TextReader, StkPatternFileOptions) for detailed information.

Namespace: AGI.Foundation.Stk
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public static StkPatternFile ReadFrom(
	string fileName,
	StkPatternFileOptions readOptions
)

Public Shared Function ReadFrom ( 
	fileName As String,
	readOptions As StkPatternFileOptions
) As StkPatternFile

public:
static StkPatternFile^ ReadFrom(
	String^ fileName, 
	StkPatternFileOptions^ readOptions
)

static member ReadFrom : 
        fileName : string * 
        readOptions : StkPatternFileOptions -> StkPatternFile

Parameters

fileName: Type: SystemString
The name of the file from which to read the pattern.
readOptions: Type: AGI.Foundation.StkStkPatternFileOptions
An object containing any additional instructions for the read process.

Return Value

Type: StkPatternFile
An StkPatternFile instance containing the read pattern file.

Exceptions

Exception	Condition
InvalidDataException	Thrown when the STK pattern file is invalid, or it contains unsupported properties or property values.
ArgumentNullException	Thrown when fileName is .

Reference

StkPatternFile Class

ReadFrom Overload

AGI.Foundation.Stk Namespace

StkPatternFileAddLanguageSpecificTextSet("LSTFAC2D0F9_0?cpp=::|nu=.");ReadFrom Method (String, StkPatternFileOptions)

Parameters

Return Value

Reference

StkPatternFileReadFrom Method (String, StkPatternFileOptions)