IVsWritableSettingsStore.GetPropertyName(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 property.

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

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

public int GetPropertyName (string collectionPath, uint index, out string propertyName);

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

Public Function GetPropertyName (collectionPath As String, index As UInteger, ByRef propertyName As String) As Integer

Parameters

collectionPath: String

[in] The path of the collection.

index: UInt32

[in] The index of the property in the collection

propertyName: 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.

Returns

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

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.

Applies to