RasGetEntryDialParamsA, fonction (ras.h)

Article
11/20/2024

La fonction RasGetEntryDialParams récupère les informations de connexion enregistrées par le dernier appel réussi au RasDial ou RasSetEntryDialParams fonction pour une entrée de livre téléphonique spécifiée.

Syntaxe

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

Paramètres

[in] unnamedParam1

Pointeur vers une chaîne null-terminated qui spécifie le chemin d’accès complet et le nom de fichier d’un fichier PBK (Phone-Book). Si ce paramètre est NULL, la fonction utilise le fichier de livre téléphonique par défaut actuel. Le fichier de carnet téléphonique par défaut est celui sélectionné par l’utilisateur dans la feuille de propriétés Préférences utilisateur de la boîte de dialogue Mise en réseau rendez-vous.

Windows Me/98/95 : Ce paramètre doit toujours être NULL. La mise en réseau rendez-vous stocke les entrées de livres téléphoniques dans le Registre plutôt que dans un fichier de livres téléphoniques.

[in, out] unnamedParam2

Pointeur vers une structure RASDIALPARAMS.

Lors de l’entrée, le membre dwSize spécifie la taille de la structure RASDIALPARAMS et le membre szEntryName spécifie une entrée de livre téléphonique valide.

En sortie, la structure reçoit les paramètres de connexion associés à l’entrée de carnet téléphonique spécifiée.

Notez que le szPhoneNumber membre de la structure ne reçoit pas le numéro de téléphone associé à l’entrée de carnet téléphonique. Pour obtenir le numéro de téléphone associé à une entrée de carnet téléphonique, appelez la fonction RasGetEntryProperties. Si szPhoneNumber est une chaîne vide dans la structure RASDIALPARAMS passée à RasDial , RasDial utilise le numéro de téléphone stocké dans l’entrée de carnet téléphonique.

Le szPassword membre de la structure RASDIALPARAMS ne retourne pas le mot de passe réel. Au lieu de cela, szPassword contient un handle pour le mot de passe enregistré. Remplacez ce handle pour le mot de passe enregistré dans les appels suivants à RasSetEntryDialParams et RasDial . Lorsqu’elle est présentée avec ce handle, RasDial récupère et utilise le mot de passe enregistré. La valeur de ce handle peut changer dans les futures versions du système d’exploitation ; ne développez pas de code qui dépend du contenu ou du format de cette valeur.

Windows NT et Windows Me/98/95 : fonctionnalité de mot de passe sécurisé non prise en charge.

[out] unnamedParam3

Pointeur vers un indicateur qui indique si la fonction a récupéré le mot de passe associé au nom d’utilisateur de l’entrée de carnet téléphonique. Le paramètre lpfPassword est TRUE si le système a enregistré un mot de passe pour l’entrée spécifiée. Si le système n’a pas de mot de passe enregistré pour cette entrée, lpfPassword est FALSE.

Windows NT et Windows Me/98/95 : La fonction définit cet indicateur sur TRUE si le mot de passe de l’utilisateur a été retourné dans le szPassword membre du RASDIALPARAMS structure pointée par lprasdialparams.

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	Description
ERROR_BUFFER_INVALID	Le pointeur lprasdialparams ou lpfPassword n’est pas valide, ou le lprasdialparams tampon n’est pas valide.
ERROR_CANNOT_OPEN_PHONEBOOK	Le carnet de téléphones est endommagé ou manquant.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée par téléphone n’existe pas.

Remarques

Note

L’en-tête ras.h définit RasGetEntryDialParams 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