FONCTION NPEnumResource (npapi.h)

Article
02/29/2024

Effectue une énumération basée sur un handle retourné par NPOpenEnum.

Syntaxe

DWORD NPEnumResource(
  [in]      HANDLE  hEnum,
  [in, out] LPDWORD lpcCount,
  [out]     LPVOID  lpBuffer,
  [in, out] LPDWORD lpBufferSize
);

Paramètres

[in] hEnum

Handle obtenu à partir d’un appel NPOpenEnum .

[in, out] lpcCount

Pointeur vers le nombre d’entrées demandées. Il peut être 0xFFFFFFFF de demander autant d’entrées que possible. Si l’appel réussit, cet emplacement reçoit le nombre d’entrées réellement lues.

[out] lpBuffer

Pointeur vers la mémoire tampon pour recevoir le résultat de l’énumération, qui est retourné sous la forme d’un tableau d’entrées NETRESOURCE . La mémoire tampon est valide jusqu’à l’appel suivant à l’aide de hEnum.

[in, out] lpBufferSize

Pointeur vers la taille, en octets, de la mémoire tampon passée à l’appel de fonction lors de l’entrée. Si la mémoire tampon est trop petite pour une seule entrée, elle doit contenir, à la sortie, le nombre d’octets nécessaires pour lire une entrée. Cette valeur est définie uniquement si le code de retour est WN_MORE_DATA.

Valeur retournée

Si la fonction réussit, elle doit retourner WN_SUCCESS. L’appelant peut continuer à appeler NPEnumResource pour continuer l’énumération. Sinon, il doit retourner l’un des codes d’erreur suivants.

Code de retour	Description
WN_NO_MORE_ENTRIES	Plus d’entrées. L’énumération a été effectuée avec succès. Lorsque cela se produit, le contenu de la mémoire tampon de retour, lpBuffer, n’est pas défini.
WN_MORE_DATA	La mémoire tampon est trop petite pour contenir une seule entrée.
WN_BAD_HANDLE	hEnum n’est pas un handle valide.
WN_NO_NETWORK	Le réseau n’est pas présent. Cette condition est vérifiée avant que la validité de hEnum ne soit testée.

Remarques

Lorsque cette fonction est appelée, le fournisseur doit remplir la mémoire tampon avec le nombre d’entrées demandé (ou le nombre maximal qui peut tenir). Les structures NETRESOURCE retournées doivent être situées contiguëment en tête de la mémoire tampon, comme un tableau de ces structures. Les pointeurs de ces structures doivent pointer vers des emplacements dans la mémoire tampon. Par conséquent, les données référencées par ces pointeurs doivent se trouver à la fin de la mémoire tampon, après le tableau de structures. Il incombe au fournisseur d’empaqueter correctement ces informations.

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