Profile Class |
ASCOM Scope Driver Helper Registry Profile Object
Inheritance HierarchySystemObject
ASCOM.UtilitiesProfile
ASCOM.UtilitiesProfile
Namespace: ASCOM.Utilities
Assembly: ASCOM.Utilities (in ASCOM.Utilities.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxThe Profile type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Profile |
Create a new Profile object
|
| Profile(Boolean) |
Create a new profile object ignoring profile not found exceptions if generated
|
Properties| Name | Description | |
|---|---|---|
 | DeviceType |
The type of ASCOM device for which profile data and registration services are provided
(String, default = "Telescope")
|
| RegisteredDeviceTypes |
List the device types registered in the Profile store
|
Methods| Name | Description | |
|---|---|---|
| CreateSubKey |
Create a registry key for the given DriverID.
|
| DeleteSubKey |
Delete a registry key for the given DriverID. SubKey may contain \ separated path to key to be deleted.
|
| DeleteValue(String, String) |
Delete the value from the registry. Name may be an empty string for the unnamed value.
|
| DeleteValue(String, String, String) |
Delete the value from the registry. Name may be an empty string for the unnamed value. Value will be deleted from the subkey supplied.
|
| Dispose |
Disposes of resources used by the profile object
|
| GetProfile |
Read an entire device profile and return it as an ASCOMProfile class instance
|
| GetProfileXML |
Read an entire device profile and return it as an XML encoded string
|
| GetValue(String, String) |
Retrieve a string value from the profile for the given Driver ID and variable name
|
| GetValue(String, String, String) |
Retrieve a string value from the profile using the supplied subkey for the given Driver ID and variable name.
|
| GetValue(String, String, String, String) |
Retrieve a string value from the profile using the supplied subkey for the given Driver ID
and variable name. Set and return the default value if the requested variable name has not yet been set.
|
| IsRegistered |
Confirms whether a specific driver is registered or unregistered in the profile store
|
| Register |
Registers a supplied DriverID and associates a descriptive name with the device
|
| RegisteredDevices |
List the devices of a given device type that are registered in the Profile store
|
| SetProfile |
Set an entire device profile from an ASCOMProfile class instance
|
| SetProfileXML |
Set an entire device profile from an XML encoded string
|
| SubKeys(String) |
Return a list of the sub-keys under the root of the given DriverID
|
| SubKeys(String, String) |
Return a list of the sub-keys under the given DriverID
|
| Unregister |
Remove all data for the given DriverID from the registry.
|
| Values(String) |
Return a list of the (unnamed and named variables) under the root of the given DriverID.
|
| Values(String, String) |
Return a list of the (unnamed and named variables) under the given DriverID and subkey.
|
| WriteValue(String, String, String) |
Writes a string value to the profile using the given Driver ID and variable name.
|
| WriteValue(String, String, String, String) |
Writes a string value to the profile using the supplied subkey for the given Driver ID and variable name.
|
RemarksThis object provides facilities for registering ASCOM drivers with the Chooser, and for storing persistence information in a shared area of the file system.
Please code to the IProfile interface
See Also