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

  • Статья

Форматирует сетевое имя в формате для конкретного поставщика для отображения в элементе управления .

Синтаксис

DWORD NPFormatNetworkName(
  [in]      LPWSTR  lpRemoteName,
  [out]     LPWSTR  lpFormattedName,
  [in, out] LPDWORD lpnLength,
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwAveCharPerLine
);

Параметры

[in] lpRemoteName

Указатель на имя сети для форматирования.

[out] lpFormattedName

Указатель на строку, получающую форматируемое имя.

[in, out] lpnLength

Указатель на DWORD , указывающий размер (в символах) буфера lpFormattedName . Если возвращаемое значение этой функции равно WN_MORE_DATA, lpnLength содержит требуемый размер буфера в символах.

[in] dwFlags

Битовое поле, указывающее тип запрашиваемого формата. Этот параметр может принимать одно из указанных ниже значений.

Значение Значение
WNFMT_MULTILINE
 Поставщик должен поместить обратную косую черту n (\\n), где в имени должны отображаться разрывы строк. Должно быть указано полное имя.
WNFMT_ABBREVIATED
 Поставщик должен сократить сетевое имя, чтобы наиболее полезная для пользователя информация помещалась в доступное пространство.
 

Кроме того, следующий флаг, который выступает в качестве модификатора для предыдущих флагов, можно включить с помощью побитовой операции ИЛИ .

Значение Значение
WNFMT_INENUM
 Сетевое имя представлено в контексте перечисления, где имя контейнера отображается непосредственно перед сетевым именем в перечислении. Это позволяет поставщикам сетей удалять избыточные сведения из форматированного имени, обеспечивая менее беспорядочное отображение для пользователя.

[in] dwAveCharPerLine

Указывает среднее число символов, которые будут помещаться в одной строке, где представлено сетевое имя. В частности, это значение определяется как ширина элемента управления, разделенная на поле tmAveCharWidth структуры TEXTMETRIC из шрифта, используемого для отображения в элементе управления.

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

Если функция выполнена успешно, она должна вернуть WN_SUCCESS.

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

Код возврата Описание
WN_MORE_DATA
 Входной буфер слишком мал.

Комментарии

Эта функция позволяет поставщикам сети обрезать или изменять сетевые имена перед их представлением пользователю. Например, в общем диалоговом окне Открыть в поле со списком Диски отображаются все подключенные ресурсы и связанные с ними сетевые имена. Перед отображением каждого элемента вызывается NPFormatNetworkName , а поставщик сети может изменить имя таким образом, чтобы оно поместилось в поле со списком. Что еще более важно, поставщик сети может изменить имя, чтобы предоставить пользователю наиболее значительную часть сетевого имени.

Обратите внимание, что NPFormatNetworkName не направляется к каждому поставщику сети, как и большинство других функций поставщика сети. Каждому поставщику сети нужно беспокоиться только о форматировании собственного сетевого имени. Они могут предполагать, что в NPFormatNetworkName будут передаваться только имена, созданные драйвером поставщика сети.

Флаги WNFMT_ обычно передаются в различных местах пользовательского интерфейса, как описано в следующей таблице. Не следует делать никаких предположений о том, какие флаги передаются где; Эта таблица предоставляется исключительно для того, чтобы помочь каждому поставщику сети выбрать оптимальный способ изменения имени своей сети.

Расположение отображения WNFMT_ MULTILINE WNFMT_ СОКРАЩЕННОЕ WNFMT_ INENUM
Диалоговое окно Подключение к диспетчеру файлов, поле со списком Диск , выбор. (Раздел выбора поля со списком — это верхний прямоугольник над разделом списка, в котором отображается текущее выделение.)   X  
Диалоговое окно Подключение к диспетчеру файлов, поле со списком Диск , список. (Раздел списка поля со списком — это поле со списком, которое отображается под выделенной частью поля со списком.) X    
Диспетчер файлов, список общих каталогов .   X X
Список отключений сетевого диска диспетчера файлов. X    
Диспетчер файлов, панель инструментов, поле со списком, выбор.   X  
Диспетчер файлов, панель инструментов, поле со списком, список. X    
Общие диалоговые окна "Открыть " и "Сохранить ", поле со списком "Диск ", выбор.   X  
Общие диалоговые окна Открытие и сохранение , поле со списком Диска , список.   X  

Требования

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