RasGetCustomAuthDataA, fonction (ras.h)

Article
11/20/2024

Utilisez la fonction RasGetCustomAuthData pour récupérer les informations d’authentification spécifiques à la connexion. Ces informations ne sont pas spécifiques à un utilisateur particulier.

Syntaxe

DWORD RasGetCustomAuthDataA(
  [in]      LPCSTR pszPhonebook,
  [in]      LPCSTR pszEntry,
  [out]     BYTE   *pbCustomAuthData,
  [in, out] DWORD  *pdwSizeofCustomAuthData
);

Paramètres

[in] pszPhonebook

Pointeur vers une chaîne null-terminated qui spécifie le chemin d’accès complet du fichier PBK (Phone-Book). Si ce paramètre est NULL, la fonction utilise le carnet de téléphones système.

[in] pszEntry

Pointeur vers une chaîne null-terminated qui spécifie un nom d’entrée existant.

[out] pbCustomAuthData

Pointeur vers une mémoire tampon qui reçoit les données d’authentification. L’appelant doit allouer la mémoire pour cette mémoire tampon. Si la mémoire tampon n’est pas suffisamment grande, RasGetCustomAuthData retourne ERROR_BUFFER_TOO_SMALL, et le paramètre pdwSizeofEapData contient la taille requise.

[in, out] pdwSizeofCustomAuthData

Pointeur vers une variable DWORD qui, lors de l’entrée, spécifie la taille de la mémoire tampon pointée par le paramètre pbCustomAuthData.

Si la mémoire tampon spécifiée par le paramètre pbCustomAuthData n’est pas suffisamment volumineuse, pdwSizeofEapData reçoit, en sortie, la taille requise.

Valeur de retour

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

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants ou une valeur de Codes d’erreur d’acheminement et d’accès à distance ou Winerror.h.

Valeur	Signification
E_INVALIDARG	Le paramètre pdwSizeofCustomAuthData est NULL.
ERROR_BUFFER_TOO_SMALL	La mémoire tampon pointée par pbCustomAuthData est trop petite pour recevoir les données. La pdwSizeofCustomAuthData contient la taille requise.
ERROR_CANNOT_OPEN_PHONEBOOK	RasGetEapUserData n’a pas pu ouvrir le fichier de livre téléphonique spécifié.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	RasGetEapUserData n’a pas pu trouver l’entrée spécifiée dans le carnet de téléphones.
autres	Utilisez formatMessage pour récupérer le message d’erreur système correspondant au code d’erreur retourné.

Remarques

Note

L’en-tête ras.h définit RasGetCustomAuthData comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	ras.h
bibliothèque	Rasapi32.lib
DLL	Rasapi32.dll

Voir aussi

RasGetEapUserData

RasSetCustomAuthData

Partager via