RasSetSubEntryPropertiesA, fonction (ras.h)

  • Article

La fonction RasSetSubEntryProperties crée une sous-entrée ou modifie une sous-entrée existante d’une entrée de répertoire 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 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. Si l’index correspond à un index de sous-entrée existant, la fonction modifie les propriétés de cette sous-entrée. Si l’index ne correspond pas à un index existant, la fonction crée une sous-entrée.

[in] unnamedParam4

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

La structure peut être suivie d’un tableau de chaînes de numéro de téléphone alternatives terminées par null. La dernière chaîne est terminée par deux caractères null consécutifs. Le membre dwAlternateOffset 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 .

[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

Spécifie la taille du bloc de configuration d’appareil TAPI. Ce paramètre n’est actuellement pas utilisé. L’appelant doit passer zéro 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_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 de l’annuaire téléphonique n’existe pas.
ERROR_CANNOT_OPEN_PHONEBOOK
 L’annuaire téléphonique est endommagé ou des composants manquants.
ERROR_INVALID_PARAMETER
 La fonction a été appelée avec un paramètre non valide.

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 de répertoire téléphonique avec plusieurs sous-entrées peut être configurée pour composer la première sous-entrée disponible ou toutes les sous-entrées lorsque l’entrée est composer.

Utilisez la fonction RasGetEntryProperties pour récupérer la structure RASENTRY contenant des informations sur les sous-entrées d’une entrée de livre 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 RasSetSubEntryProperties 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

Voir aussi

RASENTRY

RASSUBENTRY

RasGetEntryProperties

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

Fonctions du service d’accès à distance