IVsSettingsStore.GetSubCollectionName Method
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)
Syntax
'Declaration
Function GetSubCollectionName ( _
collectionPath As String, _
index As UInteger, _
<OutAttribute> ByRef subCollectionName As String _
) As Integer
int GetSubCollectionName(
string collectionPath,
uint index,
out string subCollectionName
)
int GetSubCollectionName(
[InAttribute] String^ collectionPath,
[InAttribute] unsigned int index,
[OutAttribute] String^% subCollectionName
)
abstract GetSubCollectionName :
collectionPath:string *
index:uint32 *
subCollectionName:string byref -> int
function GetSubCollectionName(
collectionPath : String,
index : uint,
subCollectionName : String
) : int
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.
Remarks
The returned name can be appended to the path to query the properties and sub-collections in this sub-collection.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.