Función NPFormatNetworkName (npapi.h)

  • Artículo

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

Sintaxis

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 valores siguientes.

Valor Significado
WNFMT_MULTILINE
 El proveedor debe colocar la barra diagonal inversa n (\\n) donde deben aparecer saltos de línea en el nombre. Se debe expresar el nombre completo.
WNFMT_ABBREVIATED
 El proveedor debe acortar el nombre de red para que la información más útil para el usuario se ajuste al espacio disponible.
 

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

Valor Significado
WNFMT_INENUM
 El nombre de red se presenta en el contexto de una enumeración donde el nombre del "contenedor" aparece inmediatamente antes del nombre de red en la enumeración. Esto permite a los proveedores de red quitar información redundante del nombre con formato, lo que proporciona una pantalla menos desordenada para el usuario.

[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.

Código devuelto Descripción
WN_MORE_DATA
 El búfer de entrada es demasiado pequeño.

Comentarios

Esta función permite a los proveedores de red recortar o modificar los nombres de red antes de que se presenten 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 se deben realizar suposiciones 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.

Ubicación de visualización WNFMT_ MULTILINE WNFMT_ ABREVIADO WNFMT_ INENUM
Cuadro de diálogo Conexión del Administrador de archivos, cuadro combinado Unidad , selección. (La sección de selección del cuadro combinado es el rectángulo superior, encima de la sección de lista, que muestra la selección actual).   X  
Cuadro de diálogo Conexión del Administrador de archivos, cuadro combinado Unidad , lista. (La sección de lista del cuadro combinado es el cuadro de lista que aparece debajo de la parte de selección del cuadro combinado). X    
Administrador de archivos, lista de directorios compartidos .   X X
Lista de unidades de red desconexión del Administrador de archivos. X    
Administrador de archivos, barra de herramientas, cuadro combinado, selección.   X  
Administrador de archivos, barra de herramientas, cuadro combinado, lista. X    
Cuadros de diálogo Abrir y guardar comunes, Cuadro combinado Unidad , selección.   X  
Cuadros de diálogo abrir y guardar comunes, cuadro combinado Unidad , lista.   X  

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado npapi.h