IVsSettingsStore::GetSubCollectionName Method (String^, UInt32, String^)

 

Returns the name of a sub collection.

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

int GetSubCollectionName(
	String^ collectionPath,
	unsigned int index,
	[OutAttribute] String^% subCollectionName
)

Parameters

collectionPath
Type: System::String^

[in] The path of the collection.

index
Type: System::UInt32

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

subCollectionName
Type: System::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.

Return Value

Type: System::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.

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

Return to top
Show: