IVsSettingsStore.GetSubCollectionName(String, UInt32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Returns the name of a sub collection.

public:
 int GetSubCollectionName(System::String ^ collectionPath, System::UInt32 index, [Runtime::InteropServices::Out] System::String ^ % subCollectionName);

int GetSubCollectionName(std::wstring const & collectionPath, unsigned int index, [Runtime::InteropServices::Out] std::wstring const & & subCollectionName);

public int GetSubCollectionName (string collectionPath, uint index, out string subCollectionName);

abstract member GetSubCollectionName : string * uint32 * string -> int

Public Function GetSubCollectionName (collectionPath As String, index As UInteger, ByRef subCollectionName As String) As Integer

Parameters

collectionPath: String

[in] The path of the collection.

index: UInt32

[in] The index of the sub-collection. Zero-based.

subCollectionName: String

[out] The sub-collection name. This parameter should point to an uninitialized BSTR and the method will allocate enough space to hold the name of the requested sub collection. The caller should call SysFreeString to release the BSTR when it is no longer needed.

Returns

Int32

Returns S_OK if the sub collection name was returned, or E_INVALIDARG if the index is greater than or equal to the number of sub-collections, or the collection does not exist.

Remarks

The returned name can be appended to the path to query the properties and sub-collections in this sub-collection.

Applies to