Функция 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

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

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

[in] dwAveCharPerLine

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

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

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

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

Замечания

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

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

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

Требования