RasSetSubEntryPropertiesA, fonction (ras.h)

Article
11/20/2024

La fonction RasSetSubEntryProperties crée une sous-entité ou modifie une sous-entité existante d’une entrée de livre téléphonique spécifiée.

Syntaxe

DWORD RasSetSubEntryPropertiesA(
  [in] LPCSTR         unnamedParam1,
  [in] LPCSTR         unnamedParam2,
  [in] DWORD          unnamedParam3,
  [in] LPRASSUBENTRYA unnamedParam4,
  [in] DWORD          unnamedParam5,
  [in] LPBYTE         unnamedParam6,
  [in] DWORD          unnamedParam7
);

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] unnamedParam2

Pointeur vers une chaînenull-terminated qui spécifie le nom d’une entrée existante dans le carnet de téléphones.

[in] unnamedParam3

Spécifie l’index de base unique de la sous-entité. Si l’index correspond à un index de sous-entité existant, la fonction modifie les propriétés de cette sous-entité. Si l’index ne correspond pas à un index existant, la fonction crée une sous-entité.

[in] unnamedParam4

Pointeur vers la structure RASSUBENTRY qui spécifie les données de la sous-entité.

La structure peut être suivie d’un tableau de chaînes de null-terminated alternate phone number strings. La dernière chaîne est arrêtée par deux caractères null consécutifs. La dwAlternateOffset membre de la structure RASSUBENTRY contient le décalage vers la première chaîne.

[in] unnamedParam5

Spécifie la taille, en octets, de la mémoire tampon lpRasSubEntry tampon.

[in] unnamedParam6

Pointeur vers un bloc de configuration d’appareil TAPI. Ce paramètre n’est actuellement pas utilisé. L’appelant doit passer NULL pour ce paramètre. Pour plus d’informations sur les blocs de configuration d’appareil TAPI, consultez la fonction lineGetDevConfig.

[in] unnamedParam7

Spécifie la taille du bloc de configuration de l’appareil TAPI. Ce paramètre n’est actuellement pas utilisé. L’appelant doit passer zéro pour ce paramètre.

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
ERROR_BUFFER_INVALID	L’adresse ou la mémoire tampon spécifiée par lpRasEntry n’est pas valide.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée par téléphone n’existe pas.
ERROR_CANNOT_OPEN_PHONEBOOK	Le carnet de téléphones est endommagé ou manquant.
ERROR_INVALID_PARAMETER	La fonction a été appelée avec un paramètre non valide.

Remarques

Une entrée par téléphone RAS peut avoir zéro ou plusieurs sous-entités, chacune composée minimalement d’un appareil et d’un numéro de téléphone. Une entrée de carnet téléphonique avec plusieurs sous-entités peut être configurée pour composer le premier sous-ensemble disponible ou toutes les sous-entités lorsque l’entrée est dialée.

Utilisez la fonction RasGetEntryProperties pour récupérer la structure RASENTRY contenant des informations sur les sous-types d’une entrée téléphonique. Le membre dwSubEntries indique le nombre de sous-types et le membre dwDialMode indique la configuration de numérotation.

Note

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

RASENTRY

RASSUBENTRY

RasGetEntryProperties

Vue d’ensemble service d’accès à distance (RAS)

fonctions de service d’accès à distance

Partager via