IVsSettingsStore Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Enumerates and reads the selected scope's collections and properties. It is obtained from the GetReadOnlySettingsStore(UInt32, IVsSettingsStore) method.

public interface class IVsSettingsStore

public interface class IVsSettingsStore

__interface IVsSettingsStore

[System.Runtime.InteropServices.Guid("6B43326C-AB7C-4263-A7EF-354B9DCBF3D8")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsSettingsStore

[<System.Runtime.InteropServices.Guid("6B43326C-AB7C-4263-A7EF-354B9DCBF3D8")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsSettingsStore = interface

Public Interface IVsSettingsStore

Derived

Microsoft.VisualStudio.Shell.Interop.IVsWritableSettingsStore

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

In these methods, if the collection path is given as the empty string (""), then it denotes the top level collection. If the property name is the empty string, then it denotes the default property of the collection. Collections can contain properties and sub-collections. Sub-collection paths are strings, such as the directory paths of file systems. A path contains the names of all the parent collections. The separator used between the names of the parent collections is the backslash character. A sub-collection path has the following form:

Root Collection\Internal Collection\Leaf Collection

Methods

CollectionExists(String, Int32)	Determines whether the given collection exists.
GetBinary(String, String, UInt32, Byte[], UInt32[])	Returns the value of the requested property whose data type is SettingsType_Binary.
GetBool(String, String, Int32)	Returns a boolean type property.
GetBoolOrDefault(String, String, Int32, Int32)	Returns a boolean type property value or a specified default value.
GetInt(String, String, Int32)	Returns an integer type property value.
GetInt64(String, String, Int64)	Returns a 64-bit integer type property value.
GetInt64OrDefault(String, String, Int64, Int64)	Returns a 64-bit integer value or a specified default value.
GetIntOrDefault(String, String, Int32, Int32)	Returns an integer type property or a specified default value.
GetLastWriteTime(String, SYSTEMTIME[])	Returns the last time a value was written in a specified collection, including all its properties and sub-collections.
GetPropertyCount(String, UInt32)	Returns the number of properties in a specified collection.
GetPropertyName(String, UInt32, String)	Returns the name of a property.
GetPropertyType(String, String, UInt32)	Returns the type of a specified property.
GetString(String, String, String)	Returns a string type property value.
GetStringOrDefault(String, String, String, String)	Returns a string type property value or a given default string.
GetSubCollectionCount(String, UInt32)	Returns the number of sub-collections in the specified collections.
GetSubCollectionName(String, UInt32, String)	Returns the name of a sub collection.
GetUnsignedInt(String, String, UInt32)	Returns an unsigned integer property value.
GetUnsignedInt64(String, String, UInt64)	Returns a 64-bit unsigned long integer property value.
GetUnsignedInt64OrDefault(String, String, UInt64, UInt64)	Returns a 64-bit unsigned long integer property of a given default value.
GetUnsignedIntOrDefault(String, String, UInt32, UInt32)	Returns an unsigned integer property or a given default value.
PropertyExists(String, String, Int32)	Determines whether a property exists in a given collection.