NetWkstaTransportEnum, fonction (lmwksta.h)

Article
08/24/2023

La fonction NetWkstaTransportEnum fournit des informations sur les protocoles de transport gérés par le redirecteur, qui est le logiciel sur l’ordinateur client qui génère des demandes de fichiers à l’ordinateur serveur.

Syntaxe

NET_API_STATUS NET_API_FUNCTION NetWkstaTransportEnum(
  [in]      LPTSTR  servername,
  [in]      DWORD   level,
  [out]     LPBYTE  *bufptr,
  [in]      DWORD   prefmaxlen,
  [out]     LPDWORD entriesread,
  [out]     LPDWORD totalentries,
  [in, out] LPDWORD resume_handle
);

Paramètres

[in] servername

Pointeur vers une chaîne qui spécifie le nom DNS ou NetBIOS du serveur distant sur lequel la fonction doit s’exécuter. Si ce paramètre a la valeur NULL, l’ordinateur local est utilisé.

[in] level

Niveau d’informations demandées pour les données. Ce paramètre peut être la valeur suivante.

Valeur	Signification
0	Retourner les informations du protocole de transport de station de travail. Le paramètre bufptr pointe vers un tableau de structures WKSTA_TRANSPORT_INFO_0 .

[out] bufptr

Pointeur vers la mémoire tampon qui reçoit les données. 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 . Notez que vous devez libérer la mémoire tampon même si la fonction échoue avec ERROR_MORE_DATA ou NERR_BufTooSmall.

[in] prefmaxlen

Longueur maximale préférée des données retournées, en octets. Si vous spécifiez MAX_PREFERRED_LENGTH, la fonction alloue la quantité de mémoire requise pour les données. Si vous spécifiez une autre valeur dans ce paramètre, cela peut limiter le nombre d’octets retournés 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 ou NERR_BufTooSmall. 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] resume_handle

Pointeur vers une valeur qui contient un handle de reprise utilisé pour poursuivre une recherche de transport de station de travail existante. Le handle doit être égal à zéro lors du premier appel et laisser inchangé pour les appels suivants. Si le paramètre resumehandle est un pointeur 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 peut être l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_MORE_DATA	D’autres entrées sont disponibles. Spécifiez une mémoire tampon suffisamment grande pour recevoir toutes les entrées.
ERROR_INVALID_LEVEL	Le paramètre level, qui indique le niveau d’informations sur la structure des données disponibles, n’est pas valide. Cette erreur est retournée si le paramètre level est spécifié en tant que valeur autre que zéro.
ERROR_INVALID_PARAMETER	Un ou plusieurs paramètres n’étaient pas valides. Cette erreur est retournée si les paramètres bufptr ou entriesread sont des pointeurs NULL .
ERROR_NOT_ENOUGH_MEMORY	La mémoire disponible était insuffisante pour traiter la demande.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette erreur est retournée si un serveur distant a été spécifié dans le paramètre servername et que cette requête n’est pas prise en charge sur le serveur distant.
NERR_BufTooSmall	D’autres entrées sont disponibles. Spécifiez une mémoire tampon suffisamment grande pour recevoir toutes les entrées. Ce code d’erreur est défini dans le fichier d’en-tête Lmerr.h .

Remarques

Aucune appartenance à un groupe spécial n’est requise pour exécuter correctement la fonction NetWkstaTransportEnum .

Configuration requise

Condition requise	Valeur
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	lmwksta.h (include Lm.h)
Bibliothèque	Netapi32.lib
DLL	Netapi32.dll