WritableSettingsStore Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Abstract class for both reading and writing the selected scope's collections and properties. It is obtained from GetWritableSettingsStore(SettingsScope) method.
This class is derived from the SettingsStore hence it inherits all the functionalities from it. It adds property and collection manipulation abilities on top of it.
public ref class WritableSettingsStore abstract : Microsoft::VisualStudio::Settings::SettingsStore[Windows::Foundation::Metadata::WebHostHidden]
public ref class WritableSettingsStore abstract : Microsoft::VisualStudio::Settings::SettingsStore[Windows::Foundation::Metadata::WebHostHidden]
class WritableSettingsStore abstract : Microsoft::VisualStudio::Settings::SettingsStorepublic abstract class WritableSettingsStore : Microsoft.VisualStudio.Settings.SettingsStoretype WritableSettingsStore = class
inherit SettingsStorePublic MustInherit Class WritableSettingsStore
Inherits SettingsStore- Inheritance
Remarks
This class is safe to access from any thread.
Constructors
| WritableSettingsStore() |
Initializes a new instance of WritableSettingsStore. |
Methods
| CollectionExists(String) |
Checks the existance of the collection passed in to this method. (Inherited from SettingsStore) |
| CreateCollection(String) |
Creates the given collection path by creating each nested collection while skipping the ones that already exist. If the full path of collections already exist, the method simply returns. |
| DeleteCollection(String) |
Deletes the given collection recursively deleting all of the sub collections and properties in it. If the collection does not exist or an empty string ("") is passed then the method returns false. |
| DeleteProperty(String, String) |
Deletes the given property from the collection. If the property or the collection does not exist then the method returns false. |
| GetBoolean(String, String, Boolean) |
Returns the value of the requested property whose data type is Int32 as boolean. (Inherited from SettingsStore) |
| GetBoolean(String, String) |
Returns the value of the requested property whose data type is Int32 as boolean. (Inherited from SettingsStore) |
| GetInt32(String, String, Int32) |
Returns the value of the requested property whose data type is Int32. (Inherited from SettingsStore) |
| GetInt32(String, String) |
Returns the value of the requested property whose data type is Int32. (Inherited from SettingsStore) |
| GetInt64(String, String, Int64) |
Returns the value of the requested property whose data type is Int64. (Inherited from SettingsStore) |
| GetInt64(String, String) |
Returns the value of the requested property whose data type is Int64. (Inherited from SettingsStore) |
| 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. (Inherited from SettingsStore) |
| 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. (Inherited from SettingsStore) |
| GetPropertyCount(String) |
Returns the number of properties under the given collection. (Inherited from SettingsStore) |
| GetPropertyNames(String) |
Returns the names of properties under the given collection. (Inherited from SettingsStore) |
| GetPropertyNamesAndValues(String) |
Returns the names of properties along with each properties associated value for the given collection. (Inherited from SettingsStore) |
| GetPropertyType(String, String) |
Returns the type of the requested property. (Inherited from SettingsStore) |
| GetString(String, String, String) |
Returns the value of the requested property whose data type is String. (Inherited from SettingsStore) |
| GetString(String, String) |
Returns the value of the requested property whose data type is String. (Inherited from SettingsStore) |
| GetStrings(String, String) |
Returns the values of the requested property whose data type is MultiString. (Inherited from SettingsStore) |
| GetSubCollectionCount(String) |
Returns the number of sub collections under the given collection. (Inherited from SettingsStore) |
| GetSubCollectionNames(String) |
Returns the names of sub collections under the given collection. (Inherited from SettingsStore) |
| GetUInt32(String, String, UInt32) |
Returns the value of the requested property whose data type is Int32. (Inherited from SettingsStore) |
| GetUInt32(String, String) |
Returns the value of the requested property whose data type is Int32. (Inherited from SettingsStore) |
| GetUInt64(String, String, UInt64) |
Returns the value of the requested property whose data type is Int64. (Inherited from SettingsStore) |
| GetUInt64(String, String) |
Returns the value of the requested property whose data type is Int64. (Inherited from SettingsStore) |
| PropertyExists(String, String) |
Checks the existance of the property passed in to this method. (Inherited from SettingsStore) |
| SetBoolean(String, String, Boolean) |
Updates the value of the specified property to the given Boolean value while setting its data type to Int32. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| SetInt32(String, String, Int32) |
Updates the value of the specified property to the given integer value while setting its data type to Int32. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| SetInt64(String, String, Int64) |
Updates the value of the specified property to the given long value while setting its data type to Int64. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| SetMemoryStream(String, String, MemoryStream) |
Updates the value of the specified property to the bits of the MemoryStream while setting its data type to Binary. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| SetString(String, String, String) |
Updates the value of the specified property to the given string value while setting its data type to String. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| SetUInt32(String, String, UInt32) |
Updates the value of the specified property to the given unsigned integer value while setting its data type to Int32. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| SetUInt64(String, String, UInt64) |
Updates the value of the specified property to the given unsigned long value while setting its data type to Int64. If the previous data type of the property is different, it overwrites it. If the property does not exist it creates one. |
| TryGetBoolean(String, String, Boolean) |
Gets the value of the requested property whose data type is Int32 as boolean. (Inherited from SettingsStore) |
| TryGetInt32(String, String, Int32) |
Gets the value of the requested property whose data type is Int32. (Inherited from SettingsStore) |
| TryGetInt64(String, String, Int64) |
Gets the value of the requested property whose data type is Int64. (Inherited from SettingsStore) |
| TryGetString(String, String, String) |
Gets the value of the requested property whose data type is String. (Inherited from SettingsStore) |
| TryGetStrings(String, String, String[]) |
Returns the values of the requested property whose data type is MultiString. (Inherited from SettingsStore) |
| TryGetUInt32(String, String, UInt32) |
Gets the value of the requested property whose data type is Int32. (Inherited from SettingsStore) |
| TryGetUInt64(String, String, UInt64) |
Gets the value of the requested property whose data type is Int64. (Inherited from SettingsStore) |