XMLProfile Class

Creates and manages an ASCOM Profile as an XML file

Definition

Namespace: ASCOM.Tools
Assembly: ASCOM.Tools (in ASCOM.Tools.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class XMLProfile : IProfile
Inheritance
Object    XMLProfile
Implements
IProfile

Constructors

XMLProfile(String, ILogger) Creates an XML profile, loading what exists at the specified path. It will save any changes at the path It is not recommended to access the same file from two different instances of this Profile at the same time
XMLProfile(String, String, UInt32, ILogger) Creates an XML profile, loading what exists at the path. This is Home or Documents /ASCOM/Alpaca/{driverID}/{deviceType}/v1/Instance-{deviceID}.xml or /ascom/alpaca/{driverID}/{deviceType}/v1/instance-{deviceID}.xml It is not recommended to access the same file from two different instances of this Profile at the same time

Properties

AlpacaDataPath Return the Alpaca folder referenced from the ApplicationDataPath
ApplicationDataPath Return ASCOM's application data folder on this Base machine

Methods

Clear Clears all setting and deletes the XML Profile file
ContainsKey Determines whether a settings key already exists
DeleteValue Deletes a key from the Profile
GetProfile Returns the whole Profile as an XML document
GetValue(String) Gets a key's current value, returning a KeyNotFound exception if the key doesn't exist
GetValue(String, String) Gets a key's current value, setting and returning the supplied default value if the key does not already exist
Keys Returns a list of Profile keys
SetProfile Sets a profile from an XML document
Values Returns a list of Profile values
WriteValue Write a key and value to the XML Profile.

Version Information

.NET Standard

Supported in: 2.0

See Also