NPOpenEnum, fonction (npapi.h)

Ouvre une énumération des ressources réseau ou des connexions existantes. La fonction NPOpenEnum doit être appelée pour obtenir un handle valide pour une énumération.

Syntaxe

DWORD NPOpenEnum(
  [in]  DWORD          dwScope,
  [in]  DWORD          dwType,
  [in]  DWORD          dwUsage,
  [in]  LPNETRESOURCEW lpNetResource,
  [out] LPHANDLE       lphEnum
);

Paramètres

[in] dwScope

Détermine l’étendue de l’énumération. Il peut s’agir de l’un des éléments suivants.

Valeur	Signification
RESOURCE_CONNECTED	Toutes les ressources actuellement connectées.
RESOURCE_GLOBALNET	Toutes les ressources sur le réseau.
RESOURCE_CONTEXT	Ressources associées au contexte réseau actuel et par défaut de l’utilisateur (utilisées pour une vue « Voisinage réseau »). L’interprétation de ceci est laissée au fournisseur.

[in] dwType

Spécifie le type de ressources intéressantes. Il s’agit d’un masque de bits, qui peut être n’importe quelle combinaison des indicateurs suivants.

Valeur	Signification
RESOURCETYPE_DISK	Toutes les ressources de disque.
RESOURCETYPE_PRINT	Toutes les ressources d’impression.
RESOURCEUSAGE_ATTACHED	Spécifie que la fonction doit échouer si l’appelant n’est pas authentifié (même si le réseau autorise l’énumération sans authentification).

 

Si dwType a la valeur 0 ou est simplement RESOURCEUSAGE_ATTACHED, tous les types de ressources sont retournés. Si un fournisseur n’a pas la capacité de faire la distinction entre les ressources d’impression et de disque au même niveau, il peut retourner toutes les ressources.

[in] dwUsage

Spécifie l’utilisation des ressources de intéressés. Il s’agit d’un masque de bits, qui peut être n’importe quelle combinaison des indicateurs suivants.

Valeur	Signification
RESOURCEUSAGE_CONNECTABLE	Toutes les ressources connectables
RESOURCEUSAGE_CONTAINER	Toutes les ressources de conteneur

 

Le masque de bits peut être égal à zéro pour correspondre à tous les indicateurs. Ce paramètre peut être ignoré si dwScope n’est pas défini sur RESOURCE_GLOBALNET.

[in] lpNetResource

Pointeur vers le conteneur pour effectuer l’énumération. Le NETRESOURCE peut avoir été obtenu par le biais d’un appel NPEnumResource précédent, ou construit par l’appelant, ou il peut être NULL. S’il a la valeur NULL ou si le champ lpRemoteName du NETRESOURCE a la valeur NULL, le fournisseur doit énumérer le niveau supérieur de son réseau. Notez que cela signifie qu’un fournisseur ne peut pas utiliser lpRemoteNamenull pour représenter une ressource réseau. Un appelant commence normalement par appeler NPOpenEnum avec ce paramètre défini sur NULL , puis utilise les résultats retournés pour une énumération supplémentaire. Si le programme appelant connaît exactement le fournisseur et le chemin d’accès distant à partir duquel énumérer, il peut créer sa propre structure NETRESOURCE à transmettre, en remplissant les champs lpProvider et lpRemoteName . Notez que si dwScope est RESOURCE_CONNECTED ou RESOURCE_CONTEXT, ce paramètre est NULL.

[out] lphEnum

Pointeur vers un handle qui peut être utilisé par la fonction NPEnumResource . Lorsque vous avez terminé d’utiliser le handle, relâchez le handle en appelant la fonction NPCloseEnum .

Valeur retournée

Si la fonction réussit, elle doit retourner WN_SUCCESS. Sinon, il doit retourner un code d’erreur qui peut inclure l’un des éléments suivants.

Code de retour	Description
WN_NOT_SUPPORTED	Le fournisseur ne prend pas en charge le type d’énumération demandé, ou la ressource réseau spécifique ne peut pas être parcourue.
WN_NOT_CONTAINER	lpNetResource ne pointe pas vers un conteneur.
WN_BAD_VALUE	DwScope, dwUsage ou dwType non valide ou une combinaison incorrecte de paramètres est spécifiée.
WN_NO_NETWORK	Le réseau n’est pas présent.

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