AsnaConfigHelper class | QSYS API Reference Guide

Provides helper functions and properties for accessing IAsnaConfig properties encoded in JSON configuration texts.

Namespace: ASNA.Extensions.Configuration Assembly: ASNA.QSys.DataGate.Client.dll

Inheritance: Object

Properties

Type	Name	Description
String	DefaultConfigFilePath	Gets the suggested full path name for a “default” configurationfile.

Signature	Description
LoadFromJson(Stream)	Returns an instance of IAsnaConfig, given a stream.
LoadFromJson(String)	Returns an instance of IAsnaConfig, given a path to aJSON-encoded file.
TryLoadFromDefaultFile(IAsnaConfig&)	Gets a configuration from the default file.

Returns an instance of IAsnaConfig, given a stream.

IAsnaConfig LoadFromJson(Stream jsonStream)

Type	Parameter name	Description
Stream	jsonStream	The input Stream.

Type	Description
IAsnaConfig	IAsnaConfig

Returns an instance of IAsnaConfig, given a path to aJSON-encoded file.

IAsnaConfig LoadFromJson(string jsonFilePath)

Type	Parameter name	Description
String	jsonFilePath

Type	Description
IAsnaConfig

Gets a configuration from the default file.

bool TryLoadFromDefaultFile(IAsnaConfig& config)

Type	Parameter name	Description
IAsnaConfig&	config	An IAsnaConfig instance, if the default configuration file named by DefaultConfigFilePath is found, loaded, and parsed. Otherwise, null.

Type	Description
Boolean	true if a configuration is loaded from thedefault config file; otherwise false.