Функция NPGetPropertyText (npapi.h)

Извлекает имена кнопок для добавления в диалоговое окно свойств для сетевого ресурса.

Синтаксис

DWORD NPGetPropertyText(
  [in]      DWORD  iButton,
  [in]      DWORD  nPropSel,
  [in]      LPWSTR lpName,
  [out]     LPWSTR lpButtonName,
  [in, out] DWORD  nButtonNameLen,
  [in]      DWORD  nType
);

Параметры

[in] iButton

Указывает индекс кнопки. Диспетчер файлов поддерживает не более шести кнопок. Этот параметр нумеруется от 1 до 6 для каждой из возможных кнопок, если выбран только один файл, или 11–16, если выбрано несколько файлов.

[in] nPropSel

Указывает элементы, на которые фокусируется диалоговое окно свойства. Это может быть одно из следующих значений.

Значение	Значение
WNPS_FILE	Один файл.
WNPS_DIR	Один каталог.
WNPS_MULT	Выбор из нескольких файлов, каталогов или и того, и другого.

[in] lpName

Указатель на строку, завершающуюся нулевым значением, которая содержит имена элементов или элементов, которые должны просматриваться или изменяться с помощью диалогового окна. Поддерживаются только файлы и каталоги, поэтому имена элементов являются именами файлов. Они должны быть однозначными, не содержать подстановочные знаки и быть полными (например, C:\LOCAL\EXAMPLE.DOC). Имена нескольких файлов должны быть разделены пробелами. Имя файла, содержащее пробелы, может быть заключено в кавычки (например, "C:\My File"). В данном случае. Оно рассматривается как одно имя. Символ курсора "^" также можно использовать в качестве механизма кавычек для отдельных символов (например, C:\My^"File, "C:\My^"File" оба ссылаются на файл C:\My"File).

[out] lpButtonName

Указатель на буфер, в который поставщик сети должен скопировать имя кнопки свойства. При успешном выполнении буфер, на который указывает lpButtonName , содержит имя кнопки свойства. Если этот буфер при выходе содержит пустую строку, то кнопка, соответствующая этому имени, и все последующие кнопки будут удалены из диалогового окна. Поставщик сети не может "пропустить" кнопку.

[in, out] nButtonNameLen

Задает размер буфера lpButtonName в символах, включая завершающий пустой символ.

[in] nType

Указывает тип элемента, который должен быть WNTYPE_FILE.

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

Если функция выполнена успешно, она должна вернуть WN_SUCCESS и можно использовать lpButtonName . Если она указывает на пустую строку, ни один из кнопок не соответствует индексу, который не соответствует значению iButton. Если возвращаемое значение отличается от WN_SUCCESS, поставщик также должен вызвать SetLastError , чтобы задать расширенные сведения об ошибке. Расширенные коды ошибок включают следующие.

Код возврата	Описание
WN_OUT_OF_MEMORY	Не удалось загрузить строку из ресурсов.
WN_MORE_DATA	Заданный буфер слишком мал для размещения текста кнопки.
WN_BAD_VALUE	Параметр lpName является непредвиденной формой.
WN_NOT_SUPPORTED	Диалоговые окна свойств не поддерживаются для заданного типа объекта nType.

Комментарии

Диспетчер файлов вызывает эту функцию каждый раз, когда открывается диалоговое окно свойств, и делает это перед отображением диалогового окна. Если пользователь нажимает кнопку, добавленную с помощью этой функции поставщиком сети, вызывается функция NPPropertyDialog с соответствующими параметрами.

Только диспетчер файлов вызывает NPGetPropertyText и использует эту функцию для файлов и каталогов.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	npapi.h