IVsSettingsStore Interface

Enumerates and reads the selected scope's collections and properties. It is obtained from the GetReadOnlySettingsStore method.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]
[GuidAttribute("6B43326C-AB7C-4263-A7EF-354B9DCBF3D8")]
public interface IVsSettingsStore

The IVsSettingsStore type exposes the following members.

  NameDescription
Public methodCollectionExistsDetermines whether the given collection exists.
Public methodGetBinaryReturns the value of the requested property whose data type is SettingsType_Binary.
Public methodGetBoolReturns a boolean type property.
Public methodGetBoolOrDefaultReturns a boolean type property value or a specified default value.
Public methodGetIntReturns an integer type property value.
Public methodGetInt64Returns a 64-bit integer type property value.
Public methodGetInt64OrDefaultReturns a 64-bit integer value or a specified default value.
Public methodGetIntOrDefaultReturns an integer type property or a specified default value.
Public methodGetLastWriteTimeReturns the last time a value was written in a specified collection, including all its properties and sub-collections.
Public methodGetPropertyCountReturns the number of properties in a specified collection.
Public methodGetPropertyNameReturns the name of a property.
Public methodGetPropertyTypeReturns the type of a specified property.
Public methodGetStringReturns a string type property value.
Public methodGetStringOrDefaultReturns a string type property value or a given default string.
Public methodGetSubCollectionCountReturns the number of sub-collections in the specified collections.
Public methodGetSubCollectionNameReturns the name of a sub collection.
Public methodGetUnsignedIntReturns an unsigned integer property value.
Public methodGetUnsignedInt64Returns a 64-bit unsigned long integer property value.
Public methodGetUnsignedInt64OrDefaultReturns a 64-bit unsigned long integer property of a given default value.
Public methodGetUnsignedIntOrDefaultReturns an unsigned integer property or a given default value.
Public methodPropertyExistsDetermines whether a property exists in a given collection.
Top

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft