Fonction RasGetSubEntryPropertiesA (ras.h)

Article
03/04/2024

La fonction RasGetSubEntryProperties récupère des informations sur une sous-entrée pour une entrée de répertoire 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 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] unnamedParam2

Pointeur vers une chaîne terminée par null qui spécifie le nom d’une entrée existante dans l’annuaire téléphonique.

[in] unnamedParam3

Spécifie l’index de base un de la sous-entrée.

[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, le cas échéant.

Lors de la sortie, la structure reçoit des informations sur la sous-entrée 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, lors de l’entrée, la taille, en octets, de la mémoire tampon lpRasSubEntry .

Lors de la 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 a la valeur 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 ligne de fonctionGetDevConfig.

[in] unnamedParam7

Pointeur vers un DWORD qui spécifie la taille du bloc de configuration d’appareil TAPI. Ce paramètre n’est actuellement pas utilisé. L’appelant doit passer null pour ce paramètre.

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
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	L’annuaire téléphonique est endommagé ou des composants sont manquants.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée de l’annuaire téléphonique n’existe pas.

Remarques

Une entrée de carnet de téléphone RAS peut avoir zéro ou plusieurs sous-entrées, chacune composée au minimum d’un appareil et d’un numéro de téléphone. Une entrée d’annuaire téléphonique avec plusieurs sous-entrées peut être configurée pour composer la première ou toutes les sous-entrées disponibles lorsque l’entrée est composer.

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

Notes

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