RasGetEntryPropertiesA, fonction (ras.h)
La fonction RasGetEntryProperties récupère les propriétés d’une entrée d’annuaire téléphonique.
Syntaxe
DWORD RasGetEntryPropertiesA(
[in] LPCSTR unnamedParam1,
[in] LPCSTR unnamedParam2,
[in, out] LPRASENTRYA unnamedParam3,
[in, out] LPDWORD unnamedParam4,
[out] LPBYTE unnamedParam5,
[in, out] LPDWORD unnamedParam6
);
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 un nom d’entrée existant. Si une chaîne vide est spécifiée, la fonction retourne les valeurs par défaut dans les mémoires tampons pointées par les paramètres lpRasEntry et lpbDeviceInfo .
[in, out] unnamedParam3
Pointeur vers une structure RASENTRY suivie d’octets supplémentaires pour la liste de numéros de téléphone de remplacement, le cas échéant.
À la sortie, la structure reçoit les données de connexion associées à l’entrée de l’annuaire téléphonique spécifiée par le paramètre lpszEntry .
Lors de l’entrée, définissez le membre dwSize de la structure sur sizeof(RASENTRY) pour identifier la version de la structure.
Ce paramètre peut être NULL.
Windows Me/98 et Windows 95 OSR2 : Microsoft Layer pour Unicode ne prend pas en charge dwAlternateOffset dans RASENTRY.
[in, out] unnamedParam4
Pointeur vers une variable qui, lors de l’entrée, spécifie la taille, en octets, de la mémoire tampon lpRasEntry .
À la sortie, cette variable reçoit le nombre d’octets requis.
Ce paramètre peut être NULL si le paramètre lpRasEntry a la valeur NULL.
Pour déterminer la taille de mémoire tampon requise, appelez RasGetEntryProperties avec lpRasEntry défini sur NULL et *lpdwEntryInfoSize défini sur zéro. La fonction retourne la taille de mémoire tampon requise dans *lpdwEntryInfoSize.
[out] unnamedParam5
Ce paramètre n’est plus utilisé. La fonction appelante doit définir ce paramètre sur NULL.
Windows Me/98/95 : Pointeur vers une mémoire tampon qui reçoit des informations de configuration spécifiques à l’appareil. Ne manipulez pas directement ces informations opaques sur l’appareil TAPI. Pour plus d’informations sur la configuration de l’appareil TAPI, consultez la fonction lineGetDevConfig dans la référence du programmeur TAPI dans le Kit de développement logiciel (SDK) de plateforme.
Ce paramètre peut être NULL.
[in, out] unnamedParam6
Ce paramètre est inutilisé. La fonction appelante doit définir ce paramètre sur NULL.
Windows Me/98/95 : Pointeur vers une variable qui, lors de l’entrée, spécifie la taille, en octets, de la mémoire tampon spécifiée par le paramètre lpbDeviceInfo .
À la sortie, cette variable reçoit le nombre d’octets requis.
Ce paramètre peut être NULL si le paramètre lpbDeviceInfo a la valeur NULL.
Pour déterminer la taille de mémoire tampon requise, appelez RasGetEntryProperties avec lpbDeviceInfo défini sur NULL et *lpdwDeviceInfoSize défini sur zéro. La fonction retourne la taille de mémoire tampon requise dans *lpdwDeviceInfoSize.
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 |
|---|---|
|
La fonction a été appelée avec un paramètre non valide. |
|
La valeur du membre dwSize du lpRasEntry est trop petite. |
|
L’adresse ou la mémoire tampon spécifiée par lpRasEntry n’est pas valide. |
|
La taille de la mémoire tampon indiquée dans lpdwEntryInfoSize est trop petite. |
|
L’entrée de l’annuaire téléphonique n’existe pas ou le fichier de l’annuaire téléphonique est endommagé et/ou comporte des composants manquants. |
Remarques
Notes
L’en-tête ras.h définit RasGetEntryProperties 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 |