IVsWritableSettingsStore::GetPropertyName Method (String^, UInt32, String^)

Visual Studio 2015

Returns the name of a property.

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

Syntax

C++

int GetPropertyName(
	String^ collectionPath,
	unsigned int index,
	[OutAttribute] String^% propertyName
)

Parameters

collectionPath: Type: System::String^
[in] The path of the collection.

index: Type: System::UInt32
[in] The index of the property in the collection

propertyName: Type: System::String^
[out] The name of the property. This should be passed as an uninitialized BSTR. The method allocates enough space to hold the name of the requested property. 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 property name was returned. If the collection does not exist or the index is bigger than or equal to the number of sub-collections, the method returns E_INVALIDARG.

Implements

IVsSettingsStore::GetPropertyName(String^, UInt32, String^)

Remarks

The index is zero-based, so it should be smaller than the number of available properties. If the index denotes the default property, then the output name is an empty string.