RasGetSubEntryPropertiesA, fonction (ras.h)

Article
11/20/2024

La fonction RasGetSubEntryProperties récupère des informations sur une sous-entrée pour une entrée de livre téléphonique spécifiée.

Syntaxe

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        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é.

[in, out] unnamedParam4

Pointeur vers la structure RASSUBENTRY suivie d’octets supplémentaires pour la liste de numéros de téléphone de remplacement, s’il en existe un.

En sortie, la structure reçoit des informations sur la sous-entité spécifiée.

Lors de l’entrée, le membre dwSize spécifie la taille de la structure. La taille identifie la version de la structure. Obtenez cette taille à l’aide de sizeof(RASSUBENTRY).

Ce paramètre peut être NULL.

[in, out] unnamedParam5

Pointeur vers une variable qui spécifie, en entrée, la taille, en octets, de la mémoire tampon lpRasSubEntry tampon.

En sortie, la variable reçoit le nombre d’octets retournés ou le nombre d’octets requis si la mémoire tampon est trop petite.

Ce paramètre peut être NULL si lpRasSubEntry est NULL .

[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

Pointeur vers un DWORD qui spécifie la taille du bloc de configuration de l’appareil TAPI. Ce paramètre n’est actuellement pas utilisé. L’appelant doit passer NULL 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_INVALID_PARAMETER	La fonction a été appelée avec un paramètre non valide.
ERROR_BUFFER_INVALID	L’adresse ou la mémoire tampon spécifiée par lpRasSubEntry n’est pas valide.
ERROR_BUFFER_TOO_SMALL	La mémoire tampon lpRasSubEntry est trop petite. La variable lpdwcb reçoit la taille de mémoire tampon requise.
ERROR_CANNOT_OPEN_PHONEBOOK	Le carnet de téléphone est endommagé ou est manquant.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée par téléphone n’existe pas.

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 disponible ou toutes les sous-entrées lorsque l’entrée est dialée.

Utilisez la fonction RasGetEntryProperties pour récupérer une structure RASENTRY contenant des informations sur les sous-types d’une entrée par téléphone. 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 RasGetSubEntryProperties 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