NPFormatNetworkName, fonction (npapi.h)

Article
02/29/2024

Met en forme un nom réseau dans un format spécifique au fournisseur pour l’afficher dans un contrôle.

Syntaxe

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

Paramètres

[in] lpRemoteName

Pointeur vers le nom du réseau à mettre en forme.

[out] lpFormattedName

Pointeur vers une chaîne qui reçoit le nom mis en forme.

[in, out] lpnLength

Pointeur vers DWORD qui spécifie la taille, en caractères, de la mémoire tampon lpFormattedName . Si la valeur de retour de cette fonction est WN_MORE_DATA, lpnLength contient la taille de mémoire tampon requise, en caractères.

[in] dwFlags

Champ de bits qui indique le type de format demandé. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
WNFMT_MULTILINE	Le fournisseur doit placer la barre oblique inverse n (\\n) où les sauts de ligne doivent apparaître dans le nom. Le nom complet doit être exprimé.
WNFMT_ABBREVIATED	Le fournisseur doit raccourcir le nom du réseau afin que les informations les plus utiles à l’utilisateur tiennent dans l’espace disponible.

En outre, l’indicateur suivant, qui joue le rôle de modificateur des indicateurs précédents, peut être inclus à l’aide d’une opération OR au niveau du bit.

Valeur	Signification
WNFMT_INENUM	Le nom du réseau est présenté dans le contexte d’une énumération où le nom du « conteneur » apparaît immédiatement avant le nom du réseau dans l’énumération. Cela permet aux fournisseurs de réseau de supprimer les informations redondantes du nom mis en forme, ce qui offre un affichage moins encombré pour l’utilisateur.

[in] dwAveCharPerLine

Spécifie le nombre moyen de caractères qui seront ajustés sur une seule ligne où le nom du réseau est présenté. Plus précisément, cette valeur est définie comme la largeur du contrôle divisée par le champ tmAveCharWidth de la structure TEXTMETRIC de la police utilisée pour l’affichage dans le contrôle.

Valeur retournée

Si la fonction réussit, elle doit retourner WN_SUCCESS.

Si la fonction échoue, elle doit retourner la valeur suivante. Toutes les autres erreurs seront ignorées et le nom de réseau non mis en forme sera utilisé.

Code de retour	Description
WN_MORE_DATA	La mémoire tampon d’entrée est trop petite.

Remarques

Cette fonction permet aux fournisseurs réseau de réduire ou de modifier les noms de réseau avant qu’ils ne soient présentés à l’utilisateur. Par exemple, dans la boîte de dialogue Ouvrir commune, la zone de liste déroulante Lecteurs présente toutes les ressources connectées et leur nom réseau associé. Avant que chaque élément ne s’affiche, NPFormatNetworkName est appelé et le fournisseur de réseau a la possibilité de modifier le nom afin qu’il figure dans la zone de liste déroulante. Plus important encore, le fournisseur de réseau peut modifier le nom pour présenter la partie la plus importante du nom réseau à l’utilisateur.

Notez que NPFormatNetworkName n’est pas routé vers chaque fournisseur de réseau, comme la plupart des autres fonctions du fournisseur de réseau. Chaque fournisseur de réseau doit se soucier uniquement de la mise en forme de son propre nom de réseau. Ils peuvent supposer que seuls les noms produits par leur pilote de fournisseur de réseau seront passés à NPFormatNetworkName.

Les indicateurs WNFMT_ sont généralement passés à différents emplacements dans l’interface utilisateur, comme décrit dans le tableau suivant. Aucune hypothèse ne doit être faite sur les indicateurs passés où ; Ce tableau est fourni uniquement pour aider chaque fournisseur réseau à choisir la meilleure méthode pour modifier son nom de réseau.

Emplacement d’affichage	WNFMT_ MULTILINE	WNFMT_ ABRÉGÉ	WNFMT_ INUM
Boîte de dialogue Connexion au gestionnaire de fichiers, zone de liste déroulante Lecteur , sélection. (La section sélection de la zone de liste déroulante est le rectangle supérieur, au-dessus de la section de liste, qui affiche la sélection actuelle.)		X
Boîte de dialogue Connexion au gestionnaire de fichiers, zone de liste déroulante Lecteur , liste. (La section liste de la zone de liste modifiable est la zone de liste qui apparaît sous la partie sélection de la zone de liste déroulante.)	X
Gestionnaire de fichiers, liste des répertoires partagés .		X	X
Liste De déconnexion du lecteur réseau du Gestionnaire de fichiers.	X
Gestionnaire de fichiers, barre d’outils, zone de liste déroulante, sélection.		X
Gestionnaire de fichiers, barre d’outils, zone de liste déroulante, liste.	X
Boîtes de dialogue Ouvrir et Enregistrer courantes, Zone de liste déroulante Lecteur , sélection.		X
Boîtes de dialogue Ouvrir et Enregistrer courantes, Zone de liste déroulante Lecteur , liste.		X

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	npapi.h

Partager via