Fonction RasGetEntryDialParamsA (ras.h)

Article
08/25/2023

La fonction RasGetEntryDialParams récupère les informations de connexion enregistrées par le dernier appel réussi à la fonction RasDial ou RasSetEntryDialParams pour une entrée de carnet de téléphone 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 terminée par null qui spécifie le chemin d’accès complet et le nom de fichier d’un fichier PBK (Phone-Book). Si ce paramètre a la valeur NULL, la fonction utilise le fichier d’annuaire par défaut actuel. Le fichier d’annuaire 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 à distance .

Windows Me/98/95 : Ce paramètre doit toujours être NULL. La mise en réseau à distance stocke les entrées d’annuaires téléphoniques dans le registre plutôt que dans un fichier d’annuaire.

[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 carnet de téléphone valide.

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

Notez que le membre szPhoneNumber de la structure ne reçoit pas le numéro de téléphone associé à l’entrée du carnet de téléphone. Pour obtenir le numéro de téléphone associé à une entrée d’annuaire 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 du répertoire téléphonique.

Le membre szPassword 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 par le mot de passe enregistré dans les appels suivants à RasSetEntryDialParams et RasDial. Lorsqu’il est présenté avec ce handle, RasDial récupère et utilise le mot de passe enregistré. La valeur de ce handle peut changer dans les versions ultérieures 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 du carnet de téléphone. Le paramètre lpfPassword a la valeur TRUE si le système a enregistré un mot de passe pour l’entrée spécifiée. Si le système n’a aucun mot de passe enregistré pour cette entrée, lpfPassword a la valeur 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 membre szPassword de la structure RASDIALPARAMS pointée par lprasdialparams.

Valeur retournée

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 provenant des codes d’erreur de routage et d’accès à distance ou winerror.h.

Valeur	Description
ERROR_BUFFER_INVALID	Le pointeur lprasdialparams ou lpfPassword n’est pas valide, ou la mémoire tampon lprasdialparams n’est pas valide.
ERROR_CANNOT_OPEN_PHONEBOOK	L’annuaire téléphonique est endommagé ou des composants manquants.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée de l’annuaire téléphonique n’existe pas.

Notes

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

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	ras.h
Bibliothèque	Rasapi32.lib
DLL	Rasapi32.dll