Función NPFormatNetworkName (npapi.h)

Da formato a un nombre de red en un formato específico del proveedor para mostrarlo en un control.

Syntax

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

Parámetros

[in] lpRemoteName

Puntero al nombre de red al que se va a dar formato.

[out] lpFormattedName

Puntero a una cadena que recibe el nombre con formato.

[in, out] lpnLength

Puntero a DWORD que especifica el tamaño, en caracteres, del búfer lpFormattedName . Si el valor devuelto de esta función es WN_MORE_DATA, lpnLength contiene el tamaño de búfer necesario, en caracteres.

[in] dwFlags

Campo de bits que indica el tipo de formato que se solicita. Este parámetro puede ser uno de los siguientes valores.

Además, la marca siguiente, que actúa como modificador de las marcas anteriores, se puede incluir mediante una operación OR bit a bit.

[in] dwAveCharPerLine

Especifica el número medio de caracteres que caben en una sola línea donde se presenta el nombre de red. En concreto, este valor se define como el ancho del control dividido por el campo tmAveCharWidth de la estructura TEXTMETRIC de la fuente utilizada para mostrar en el control.

Valor devuelto

Si la función se ejecuta correctamente, debe devolver WN_SUCCESS.

Si se produce un error en la función, debe devolver el siguiente valor. Se omitirán todos los demás errores y se usará el nombre de red sin formato.

Observaciones

Esta función permite a los proveedores de red recortar o modificar los nombres de red antes de presentarlos al usuario. Por ejemplo, en el cuadro de diálogo Abrir común, el cuadro combinado Unidades presenta todos los recursos conectados y su nombre de red asociado. Antes de que se muestre cada elemento, se llama a NPFormatNetworkName y el proveedor de red tiene la opción de editar el nombre para que se ajuste al cuadro combinado. Más importante, el proveedor de red puede editar el nombre para presentar la parte más significativa del nombre de red al usuario.

Tenga en cuenta que NPFormatNetworkName no se enruta a cada proveedor de red, como la mayoría de las demás funciones del proveedor de red. Cada proveedor de red solo necesita preocuparse por dar formato a su propio nombre de red. Pueden suponer que solo los nombres generados por su controlador de proveedor de red se pasarán a NPFormatNetworkName.

Las marcas de WNFMT_ normalmente se pasan en varios lugares de la interfaz de usuario, como se describe en la tabla siguiente. No debe hacerse ninguna suposición sobre qué marcas se pasan; esta tabla se proporciona únicamente para ayudar a cada proveedor de red a decidir el mejor método para modificar su nombre de red.

Requisitos