Fonction NPGetPropertyText (npapi.h)

Article
03/04/2024

Récupère les noms des boutons à ajouter à une boîte de dialogue de propriété pour une ressource réseau.

Syntaxe

DWORD NPGetPropertyText(
  [in]      DWORD  iButton,
  [in]      DWORD  nPropSel,
  [in]      LPWSTR lpName,
  [out]     LPWSTR lpButtonName,
  [in, out] DWORD  nButtonNameLen,
  [in]      DWORD  nType
);

Paramètres

[in] iButton

Indique l’index du bouton. Le Gestionnaire de fichiers prend en charge un maximum de six boutons. Ce paramètre est numéroté de 1 à 6 pour chacun des boutons possibles si un seul fichier est sélectionné, ou 11 à 16 si plusieurs fichiers sont sélectionnés.

[in] nPropSel

Spécifie sur quels éléments la boîte de dialogue de propriété se concentre. Il peut s’agir de l’une des valeurs suivantes.

Valeur	Signification
WNPS_FILE	Un seul fichier.
WNPS_DIR	Un répertoire unique.
WNPS_MULT	Sélection de plusieurs fichiers, répertoires ou les deux.

[in] lpName

Pointeur vers une chaîne terminée par null qui contient les noms de l’élément ou des éléments à afficher ou à modifier au moyen de la boîte de dialogue. Les seuls éléments pris en charge sont des fichiers et des répertoires. Les noms d’éléments sont donc des noms de fichiers. Celles-ci doivent être non ambiguës, ne contenir aucun caractère générique et être entièrement qualifiées (par exemple, C:\LOCAL\EXAMPLE.DOC). Plusieurs noms de fichiers doivent être séparés par des espaces. Un nom de fichier qui contient des espaces peut être entouré de guillemets (par exemple, « C :\Mon fichier »). Dans ce cas. il est traité comme un nom unique. Le caractère de caresse '^' peut également être utilisé comme mécanisme de guillemets pour les caractères uniques (par exemple, C :\My^"File, « C :\My^"File » font tous deux référence au fichier C :\My"File).

[out] lpButtonName

Pointeur vers une mémoire tampon dans laquelle le fournisseur réseau doit copier le nom du bouton de propriété. En cas de réussite, la mémoire tampon pointée vers lpButtonName contient le nom du bouton de propriété. Si cette mémoire tampon, à la sortie, contient la chaîne vide, le bouton correspondant à ce nom et tous les boutons suivants sont supprimés de la boîte de dialogue. Le fournisseur réseau ne peut pas « ignorer » un bouton.

[in, out] nButtonNameLen

Spécifie la taille de la mémoire tampon lpButtonName en caractères, y compris le caractère null de fin.

[in] nType

Spécifie le type d’élément, qui doit être WNTYPE_FILE.

Valeur retournée

Si la fonction réussit, elle doit retourner WN_SUCCESS et lpButtonName peut être utilisé. S’il pointe vers la chaîne vide, aucun bouton ne correspond à un index aussi élevé qu’iButton. Si la valeur de retour est autre que WN_SUCCESS, le fournisseur doit également appeler SetLastError pour définir les informations d’erreur étendues. Les codes d’erreur étendus incluent les éléments suivants.

Code de retour	Description
WN_OUT_OF_MEMORY	Impossible de charger la chaîne à partir de ressources.
WN_MORE_DATA	La mémoire tampon donnée est trop petite pour s’adapter au texte du bouton.
WN_BAD_VALUE	Le paramètre lpName est une forme inattendue.
WN_NOT_SUPPORTED	Les boîtes de dialogue de propriété ne sont pas prises en charge pour le type d’objet donné, nType.

Remarques

Le Gestionnaire de fichiers appelle cette fonction chaque fois que la boîte de dialogue de propriété est affichée, et il le fait avant d’afficher la boîte de dialogue. Si l’utilisateur clique sur un bouton ajouté via cette fonction par le fournisseur réseau, la fonction NPPropertyDialog est appelée avec les paramètres appropriés.

Seul le Gestionnaire de fichiers appelle NPGetPropertyText, et il utilise cette fonction pour les fichiers et les répertoires.

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

Share via