RasSetAutodialAddressA, fonction (ras.h)
La fonction RasSetAutodialAddress peut ajouter une adresse à la base de données de mappage AutoDial. La fonction peut également supprimer ou modifier les données associées à une adresse existante dans la base de données.
Syntaxe
DWORD RasSetAutodialAddressA(
[in] LPCSTR unnamedParam1,
[in] DWORD unnamedParam2,
[in] LPRASAUTODIALENTRYA unnamedParam3,
[in] DWORD unnamedParam4,
[in] DWORD unnamedParam5
);
Paramètres
[in] unnamedParam1
Pointeur vers une chaîne terminée par null qui spécifie l’adresse à ajouter, supprimer ou modifier. Cette adresse peut être une adresse IP, un nom d’hôte Internet (« www.microsoft.com ») ou un nom NetBIOS (« products1 »).
Si ce paramètre a la valeur NULL, la fonction définit la connexion Internet par défaut (voir Remarques). Si ce paramètre pointe vers une chaîne de longueur nulle, la fonction supprime la connexion Internet par défaut.
[in] unnamedParam2
Réservés au; doit être égal à zéro.
[in] unnamedParam3
Pointeur vers un tableau d’une ou plusieurs structures RASAUTODIALENTRY à associer à l’adresse lpszAddress . Si lpAutoDialEntries a la valeur NULL et que dwcbAutoDialEntries est égal à zéro, RasSetAutodialAddress supprime toutes les structures associées à lpszAddress de la base de données de mappage.
[in] unnamedParam4
Spécifie la taille, en octets, de la mémoire tampon lpAutoDialEntries .
[in] unnamedParam5
Spécifie le nombre de structures RASAUTODIALENTRY dans la mémoire tampon lpAutoDialEntries .
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 | Signification |
|---|---|
|
Le membre dwSize de la structure RASAUTODIALENTRY est une valeur non valide. |
|
Le paramètre lpszAddress est NULL. |
|
Le nom de connexion spécifié dans lpAutoDialEntries n’existe pas. |
Remarques
Une adresse dans la base de données de mappage AutoDial peut avoir un nombre quelconque d’entrées RASAUTODIALENTRY associées. Chaque entrée spécifie des informations autoDial pour un emplacement de numérotation TAPI particulier.
Si l’adresse spécifiée par le paramètre lpszAddress est une adresse existante dans la base de données et que le paramètre lpAutoDialEntries n’est pas NULL, la fonction RasSetAutodialAddress modifie le jeu d’entrées AutoDial associées à l’adresse. Si une entrée dans le tableau lpAutoDialEntries spécifie un emplacement de numérotation pour lequel l’adresse a déjà une entrée, la fonction remplace l’entrée existante par la nouvelle entrée. Sinon, la fonction ajoute simplement les entrées lpAutoDialEntries au jeu d’entrées pour l’adresse.
Si l’adresse lpszAddress existe dans la base de données, lpAutoDialEntries a la valeur NULL et lpAutoDialEntries a la valeur zéro, RasSetAutodialAddress supprime l’adresse de la base de données.
Si l’adresse lpszAddress n’existe pas dans la base de données, RasSetAutodialAddress ajoute l’adresse à la base de données. Le paramètre lpAutoDialEntries spécifie les entrées AutoDial à associer à la nouvelle adresse.
RAS prend en charge une connexion Internet par défaut globale à l’ordinateur local et une connexion Internet par défaut pour chaque utilisateur.
Lorsque le paramètre lpszAddress a la valeur NULL et que le paramètre lpAutoDialEntries spécifie un nom de connexion avec une seule entrée, RasSetAutodialAddress définit la connexion en tant que connexion Internet par défaut. Le nom de connexion spécifié dans lpAutoDialEntries doit déjà exister. Si ce n’est pas le cas, ERROR_CANNOT_FIND_PHONEBOOK_ENTRY sont retournées.
Lorsque le paramètre lpszAddress est une chaîne de longueur nulle et que le paramètre lpAutoDialEntries spécifie un nom de connexion vide avec une entrée, RasSetAutodialAddress supprime la connexion Internet par défaut.
Sur les ordinateurs clients autres que le domaine, si un utilisateur souhaite définir une connexion comme connexion Internet par défaut et spécifie une connexion « pour tous les utilisateurs » dans le membre szEntry de la structure RASAUTODIALENTRY , la connexion Internet par défaut est définie globalement sur l’ordinateur local. Dans tous les autres cas, la connexion Internet par défaut est définie individuellement pour chaque utilisateur de l’ordinateur.
Il est possible d’avoir deux connexions qui ont le même nom si l’une est configurée en tant que connexion « pour tous les utilisateurs » et l’autre en tant que connexion « pour moi uniquement ». Si le paramètre lpAutoDialEntries spécifie un nom de connexion qui correspond à la fois à une connexion globale et à une connexion par utilisateur, la connexion par utilisateur est définie.
Notes
L’en-tête ras.h définit RasSetAutodialAddress 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.
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 |