Click or drag to resize

SettingsProvider Class

Provides settings storage for ASCOM device drivers. Settings are persisted in the ASCOM Device Profile store.
Inheritance Hierarchy
SystemObject
  System.Configuration.ProviderProviderBase
    System.ConfigurationSettingsProvider
      ASCOMSettingsProvider

Namespace: ASCOM
Assembly: ASCOM.SettingsProvider (in ASCOM.SettingsProvider.dll) Version: 6.0.0.0 (6.6.9999.9999)
Syntax
public class SettingsProvider : SettingsProvider

The SettingsProvider type exposes the following members.

Constructors
 NameDescription
Public methodSettingsProvider Initializes a new instance of the SettingsProvider class with the default profile provider Profile.
Public methodSettingsProvider(IProfile) Initializes a new instance of the SettingsProvider class with the supplied Profile Provider. This is useful for injecting a mock profile object during unit testing.
Top
Properties
 NameDescription
Public propertyApplicationName Gets the name of the driver or application for which settings are being managed. This value is set during provider initialization and cannot be changed thereafter.
(Overrides SettingsProviderApplicationName)
Public propertyDescription Gets the provider's friendly description.
(Overrides ProviderBaseDescription)
Public propertyName Returns the provider's friendly name used during configuration.
(Overrides ProviderBaseName)
Top
Methods
 NameDescription
Public methodGetPropertyValues Retrieves a collection of settings values from the underlying ASCOM Profile store.
(Overrides SettingsProviderGetPropertyValues(SettingsContext, SettingsPropertyCollection))
Public methodInitialize Initializes the ASCOM Settings Provider.
(Overrides ProviderBaseInitialize(String, NameValueCollection))
Public methodSetPropertyValues Persists a collection of settings values to the underlying ASCOM Profile store.
(Overrides SettingsProviderSetPropertyValues(SettingsContext, SettingsPropertyValueCollection))
Top
Remarks
Original version by Tim Long, March 2009. Copyright © 2009 TiGra Astronomy, all rights reserved. http://www.tigranetworks.co.uk/Astronomy
See Also