IVsSettingsStore.GetPropertyName(String, UInt32, String) Метод

Определение

Возвращает имя свойства.

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 *  -> int
Public Function GetPropertyName (collectionPath As String, index As UInteger, ByRef propertyName As String) As Integer

Параметры

collectionPath
String

[in] Путь к коллекции.

index
UInt32

[in] Индекс свойства в коллекции.

propertyName
String

[out] Имя свойства. Это должно быть передано как неинициализированный BSTR. Метод выделяет достаточно места для хранения имени запрошенного свойства. Вызывающий объект должен вызвать SysFreeString, чтобы освободить строку BSTR, когда она больше не требуется.

Возвращаемое значение

Int32

Если имя свойства возвращен, возвращается значение S_OK. Если коллекция не существует или индекс больше или равен числу подколлекций, метод возвращает E_INVALIDARG.

Комментарии

Индекс отсчитывается от нуля, поэтому он должен быть меньше, чем число доступных свойств. Если индекс обозначает свойство по умолчанию, то имя выхода будет пустой строкой.

Применяется к