NPFormatNetworkName, fonction (npapi.h)

Met en forme un nom réseau dans un format spécifique au fournisseur pour l’affichage 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 être l’une des valeurs suivantes.

En outre, l’indicateur suivant, qui agit comme modificateur des indicateurs précédents, peut être inclus à l’aide d’une opération or au niveau du bit.

[in] dwAveCharPerLine

Spécifie le nombre moyen de caractères qui s’adapteront à 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 du réseau non mis en forme sera utilisé.

Remarques

Cette fonction permet aux fournisseurs de réseau de découper 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 l’affichage de chaque élément, NPFormatNetworkName est appelé et le fournisseur réseau a la possibilité de modifier le nom afin qu’il s’adapte à la zone de liste déroulante. Plus important, 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 s’inquiéter uniquement de la mise en forme de son propre nom réseau. Ils peuvent supposer que seuls les noms produits par leur pilote de fournisseur de réseau sont transmis à NPFormatNetworkName.

Les indicateurs WNFMT_ sont généralement passés à différents endroits de 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 de réseau à décider de la meilleure méthode pour modifier son nom réseau.

Spécifications