SettingsStore Class

Definition

Namespace:

Microsoft.VisualStudio.Settings

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Abstract class for reading/enumerating the selected scope's collections and properties. It is obtained from GetReadOnlySettingsStore(SettingsScope) method.

In the methods of this class if the collection path is provided as the empty string ("") then it denotes the top level collection. If the property name is empty string then it denotes the default property of the collection.

Collections can contain properties and sub-collections. Sub-collections paths are described with the separators like directories in file system. Likewise, separator is '' (back-slash) character. Example of a sub-collection path would be: "Root Collection\Internal Collection\Leaf Collection".

public ref class SettingsStore abstract

[Windows::Foundation::Metadata::WebHostHidden]
public ref class SettingsStore abstract

[Windows::Foundation::Metadata::WebHostHidden]
class SettingsStore abstract

public abstract class SettingsStore

type SettingsStore = class

Public MustInherit Class SettingsStore

Inheritance

Object

SettingsStore

Derived

Microsoft.VisualStudio.Settings.WritableSettingsStore

Examples

Example of a sub-collection path would be: "Root Collection\Internal Collection\Leaf Collection".

Remarks

In the methods of this class, if the collection path is provided as the empty string (""), then it denotes the top level collection. If the property name is empty string, then it denotes the default property of the collection.

Collections can contain properties and sub-collections. Sub-collections paths are described with the separators like directories in the file system. Likewise, the separator is '\' (back-slash) character.

Constructors

SettingsStore()

Initializes a new instance of the SettingsStore.

Methods

CollectionExists(String)	Checks the existance of the collection passed in to this method.
GetBoolean(String, String)	Returns the value of the requested property whose data type is Int32 as boolean.
GetBoolean(String, String, Boolean)	Returns the value of the requested property whose data type is Int32 as boolean.
GetInt32(String, String)	Returns the value of the requested property whose data type is Int32.
GetInt32(String, String, Int32)	Returns the value of the requested property whose data type is Int32.
GetInt64(String, String)	Returns the value of the requested property whose data type is Int64.
GetInt64(String, String, Int64)	Returns the value of the requested property whose data type is Int64.
GetLastWriteTime(String)	Provides the last write time of the properties and sub collections immediate to the given collection. The method does report any further changes internal to the sub collections (i.e. non-recursive). The last write time of a collection is updated if properties are created, deleted or their values modified or if a sub collection is created or deleted.
GetMemoryStream(String, String)	Returns the value of the requested property whose data type is Binary. In order to access the underlying byte array at once ToArray() method can be used.
GetPropertyCount(String)	Returns the number of properties under the given collection.
GetPropertyNames(String)	Returns the names of properties under the given collection.
GetPropertyNamesAndValues(String)	Returns the names of properties along with each properties associated value for the given collection.
GetPropertyType(String, String)	Returns the type of the requested property.
GetString(String, String)	Returns the value of the requested property whose data type is String.
GetString(String, String, String)	Returns the value of the requested property whose data type is String.
GetSubCollectionCount(String)	Returns the number of sub collections under the given collection.
GetSubCollectionNames(String)	Returns the names of sub collections under the given collection.
GetUInt32(String, String)	Returns the value of the requested property whose data type is Int32.
GetUInt32(String, String, UInt32)	Returns the value of the requested property whose data type is Int32.
GetUInt64(String, String)	Returns the value of the requested property whose data type is Int64.
GetUInt64(String, String, UInt64)	Returns the value of the requested property whose data type is Int64.
PropertyExists(String, String)	Checks the existance of the property passed in to this method.