IVsWritableSettingsStore.GetPropertyName Method

Статья
03/06/2013

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

'Declaration
Function GetPropertyName ( _
    collectionPath As String, _
    index As UInteger, _
    <OutAttribute> ByRef propertyName As String _
) As Integer

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

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

abstract GetPropertyName : 
        collectionPath:string * 
        index:uint32 * 
        propertyName:string byref -> int

function GetPropertyName(
    collectionPath : String, 
    index : uint, 
    propertyName : String
) : int

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.

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

Поделиться через