Fonction RasSetEntryDialParamsA (ras.h)

Article
08/25/2023

La fonction RasSetEntryDialParams modifie les informations de connexion enregistrées par le dernier appel réussi à la fonction RasDial ou RasSetEntryDialParams pour une entrée de téléphone spécifiée.

Syntaxe

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             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 d’annuaire téléphonique (PBK). Si ce paramètre a la valeur NULL, la fonction utilise le fichier d’annuaire téléphonique 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 Accès réseau à distance.

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

[in] unnamedParam2

Pointeur vers la structure RASDIALPARAMS qui spécifie les paramètres de connexion à associer à l’entrée de l’annuaire téléphonique. RasSetEntryDialParams utilise les membres de la structure comme suit.

Membre	Signification
dwSize	Doit spécifier la taille de (RASDIALPARAMS) pour identifier la version de la structure.
szEntryName	Chaîne terminée par null qui identifie l’entrée de l’annuaire téléphonique pour laquelle définir les paramètres.
szPhoneNumber	Non utilisé. Défini sur NULL.
szCallbackNumber	Chaîne terminée par null qui contient le numéro de téléphone du rappel. Si szCallbackNumber est une chaîne vide ( " ), le numéro de rappel n’est pas modifié.
szUserName	Chaîne terminée par null qui contient le nom d’ouverture de session de l’utilisateur associé à cette entrée. Si szUserName est une chaîne vide, le nom d’utilisateur n’est pas modifié.
szPassword	Chaîne terminée par null qui contient le mot de passe de l’utilisateur spécifié par szUserName. Si szUserName est une chaîne vide, le mot de passe n’est pas modifié. Si szPassword est une chaîne vide et que fRemovePassword a la valeur FALSE, le mot de passe est défini sur la chaîne vide. Si fRemovePassword a la valeur TRUE, le mot de passe stocké dans cette entrée de répertoire téléphonique pour l’utilisateur spécifié par szUserName est supprimé quel que soit le contenu de la chaîne szPassword . Windows NT 4.0 : Le mot de passe est remplacé par la chaîne spécifiée par szPassword , que szUserName soit une chaîne vide ou non. Windows XP/2000 : Si szPassword contient le handle de mot de passe retourné par RasGetCredentials ou RasGetEntryDialParams, RasSetEntryDialParams retourne correctement sans modifier le mot de passe actuellement enregistré.
szDomain	Chaîne terminée par null qui contient le nom du domaine sur lequel se connecter. Si szDomain est une chaîne vide, le nom de domaine n’est pas modifié.
dwSubEntry	Spécifie l’index (une base) de la sous-entrée initiale à composer lors de l’établissement de la connexion.
dwCallbackId	Spécifie une valeur définie par l’application que RAS passe à la fonction de rappel RasDialFunc2 .

[in] unnamedParam3

Spécifie s’il faut supprimer le mot de passe stocké de l’entrée de l’annuaire téléphonique pour l’utilisateur indiqué par lprasdialparams-szUserName>. Si fRemovePassword a la valeur TRUE, le mot de passe est supprimé. Définir fRemovePassword sur TRUE revient à cocher la case « Annuler l’enregistrement du mot de passe » case activée dans la mise en réseau à distance. Lorsque vous définissez le mot de passe ou d’autres propriétés d’une entrée d’annuaire téléphonique, définissez fRemovePassword surFALSE.

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 de Winerror.h.

Valeur	Description
ERROR_BUFFER_INVALID	L’adresse ou la mémoire tampon spécifiée par 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.

Remarques

Pour créer une entrée d’annuaire téléphonique, utilisez la fonction RasSetEntryProperties .

Windows XP ou version ultérieure : N’utilisez pas la fonction RasSetEntryDialParams . Pour définir les informations d’identification d’une entrée d’annuaire téléphonique, utilisez la fonction RasSetCredentials . Définissez les membres non-credential de RASDIALPARAMS (par exemple szCallbackNumber, dwSubEntry ou dwCallbackId) directement dans la structure RASDIALPARAMS passée en tant que paramètre à la fonction RasDial .

Notes

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

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