StkPatternFileReadFrom Method (TextReader, StkPatternFileOptions)
public static StkPatternFile ReadFrom( TextReader reader, StkPatternFileOptions readOptions )
Public Shared Function ReadFrom ( reader As TextReader, readOptions As StkPatternFileOptions ) As StkPatternFile
public: static StkPatternFile^ ReadFrom( TextReader^ reader, StkPatternFileOptions^ readOptions )
static member ReadFrom : reader : TextReader * readOptions : StkPatternFileOptions -> StkPatternFile
|InvalidDataException||Thrown when the STK pattern file is invalid or it contains unsupported properties or property values.|
The STK pattern file format is a mix of well-defined, unambiguous properties, and fairly STK-specific properties that are difficult to interpret outside of the context of STK. As a result, this method should be considered a "best effort" that works well in most common cases, but that may have problems with certain pattern files.
By default, when this method does not understand a property or property value read from the file, it will throw an InvalidDataException describing the problem. You can attempt to read files with unsupported properties or property values by setting the IgnoreUnsupportedProperties and IgnorePropertiesWithUnsupportedValues properties of the StkPatternFileOptions passed to this method to . With these properties set, unsupported properties and property values will be added to the UnsupportedProperties and PropertiesWithUnsupportedValues dictionaries, respectively, and the reader can make no guarantees that its results will match STK.
Here are the known limitations, compared to STK, when reading a pattern file using this method: