NetUseEnum, fonction (lmuse.h)

Article
08/24/2023

La fonction NetUseEnum répertorie toutes les connexions actuelles entre l’ordinateur local et les ressources sur les serveurs distants.

Vous pouvez également utiliser les fonctions WNetOpenEnum et WNetEnumResource pour énumérer les ressources réseau ou les connexions.

Syntaxe

NET_API_STATUS NET_API_FUNCTION NetUseEnum(
  [in]      LMSTR   UncServerName,
  [in]      DWORD   LevelFlags,
  [out]     LPBYTE  *BufPtr,
  [in]      DWORD   PreferedMaximumSize,
  [out]     LPDWORD EntriesRead,
  [out]     LPDWORD TotalEntries,
  [in, out] LPDWORD ResumeHandle
);

Paramètres

[in] UncServerName

Nom UNC de l’ordinateur sur lequel exécuter cette fonction. S’il s’agit du paramètre NULL, l’ordinateur local est utilisé. Si le paramètre UncServerName spécifié est un ordinateur distant, l’ordinateur distant doit prendre en charge les appels RPC distants à l’aide du mécanisme hérité du protocole d’accès à distance.

Cette chaîne est Unicode si _WIN32_WINNT ou FORCE_UNICODE sont définis.

[in] LevelFlags

Niveau d’informations des données demandées. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
0	Spécifie un nom d’appareil local et le nom de partage d’une ressource distante. Le paramètre BufPtr pointe vers un tableau de structures USE_INFO_0 .
1	Spécifie des informations sur la connexion entre un appareil local et une ressource partagée, y compris les status de connexion et le type. Le paramètre BufPtr pointe vers un tableau de structures USE_INFO_1 .
2	Spécifie des informations sur la connexion entre un appareil local et une ressource partagée. Les informations incluent le status de connexion, le type de connexion, le nom d’utilisateur et le nom de domaine. Le paramètre BufPtr pointe vers un tableau de structures USE_INFO_2 .

[out] BufPtr

Pointeur vers la mémoire tampon qui reçoit les structures d’informations. Le format de ces données dépend de la valeur du paramètre Level . Cette mémoire tampon est allouée par le système et doit être libérée à l’aide de la fonction NetApiBufferFree lorsque les informations ne sont plus nécessaires. Notez que vous devez libérer la mémoire tampon même si la fonction échoue avec ERROR_MORE_DATA.

[in] PreferedMaximumSize

Longueur maximale préférée, en octets, des données à retourner. Si MAX_PREFERRED_LENGTH est spécifié, la fonction alloue la quantité de mémoire requise pour les données. Si une autre valeur est spécifiée dans ce paramètre, elle peut limiter le nombre d’octets retourné par la fonction. Si la taille de la mémoire tampon est insuffisante pour contenir toutes les entrées, la fonction retourne ERROR_MORE_DATA. Pour plus d’informations, consultez Mémoires tampons de fonction de gestion réseau et Longueurs de mémoire tampon des fonctions de gestion réseau.

[out] EntriesRead

Pointeur vers une valeur qui reçoit le nombre d’éléments réellement énumérés.

[out] TotalEntries

Pointeur vers une valeur qui reçoit le nombre total d’entrées qui auraient pu être énumérées à partir de la position de reprise actuelle. Notez que les applications doivent considérer cette valeur uniquement comme un indicateur.

[in, out] ResumeHandle

Pointeur vers une valeur qui contient un handle de cv utilisé pour poursuivre la recherche. Le handle doit être égal à zéro lors du premier appel et laisser inchangé pour les appels suivants. Si ResumeHandle a la valeur NULL, aucun handle de reprise n’est stocké.

Valeur retournée

Si la fonction réussit, la valeur de retour est NERR_Success.

Si la fonction échoue, la valeur de retour est un code d’erreur système. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur système.

Code de retour	Description
ERROR_INVALID_PARAMETER	Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si un pointeur NULL est passé dans les paramètres BufPtr ou entriesread .
ERROR_MORE_DATA	Il y a plus de données à retourner. Cette erreur est retournée si la taille de la mémoire tampon est insuffisante pour contenir toutes les entrées.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette erreur est retournée si le paramètre UncServerName n’était pas NULL et si le serveur distant ne prend pas en charge les appels RPC distants à l’aide du mécanisme hérité du protocole d’accès à distance.
Autres	Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Notes

Aucune appartenance à un groupe spécial n’est requise pour appeler la fonction NetUseEnum . Cette fonction ne peut pas être exécutée sur un serveur distant, sauf en cas de compatibilité de niveau inférieur à l’aide du protocole d’accès à distance hérité.

Pour récupérer des informations sur une connexion réseau, vous pouvez appeler la fonction NetUseGetInfo .

Cette fonction s’applique uniquement au client Server Message Block (station de travail LAN Manager). La fonction NetUseEnum ne prend pas en charge les partages de système de fichiers distribués (DFS). Pour énumérer des partages à l’aide d’un autre fournisseur réseau (WebDAV ou partage DFS, par exemple), utilisez les fonctions WNetOpenEnum, WNetEnumResource et WNetCloseEnum .

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	lmuse.h (include Lm.h, Lmcons.h)
Bibliothèque	Netapi32.lib
DLL	Netapi32.dll