RasPhonebookDlgA, fonction (rasdlg.h)

Article
11/20/2024

La fonction RasPhonebookDlg affiche la boîte de dialogue principale Mise en réseau rendez-vous. Dans cette boîte de dialogue modale, l’utilisateur peut composer, modifier ou supprimer une entrée de carnet téléphonique sélectionnée, créer une entrée de carnet téléphonique ou spécifier les préférences de l’utilisateur. La fonction RasPhonebookDlg retourne lorsque la boîte de dialogue se ferme.

Syntaxe

BOOL RasPhonebookDlgA(
  [in]      LPSTR       lpszPhonebook,
  [in]      LPSTR       lpszEntry,
  [in, out] LPRASPBDLGA lpInfo
);

Paramètres

[in] lpszPhonebook

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.

[in] lpszEntry

Pointeur vers une chaîne null-terminated qui spécifie le nom de l’entrée phone-book à mettre en surbrillance initialement. Si ce paramètre est NULL, ou si l’entrée spécifiée n’existe pas, la boîte de dialogue met en surbrillance la première entrée de la liste alphabétique.

[in, out] lpInfo

Pointeur vers la structure RASPBDLG qui spécifie des paramètres d’entrée et de sortie supplémentaires.

Lors de l’entrée, le membre dwSize de cette structure doit spécifier la tailleof( RASPBDLG).

Si une erreur se produit, le dwError membre de la structure reçoit, en sortie, un code d’erreur ; sinon, elle reçoit zéro.

Valeur de retour

Si l’utilisateur sélectionne le bouton Connect et que la fonction établit une connexion, la valeur de retour est TRUE. Sinon, la fonction retourne faux.

Si une erreur se produit, le membre dwError de la structure RASPBDLG retourne une valeur provenant des codes d’erreur de routage et d’accès à distance ou Winerror.h.

L’exemple de code suivant affiche la boîte de dialogue Mise en réseau rendez-vous. La boîte de dialogue affiche les informations de numérotation pour la première entrée du fichier phonebook par défaut.

#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "rasdlg.h"
#pragma comment(lib, "rasapi32.lib")

int main (){
    
    // Initialize the return code
    BOOL nRet = TRUE;

    // Allocate heap memory for the RASPBLDG structure
    RASPBDLG * lpInfo = (LPRASPBDLG)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASPBDLG));
    
    // The dwsize member of lpInfo must contain the structure size, or the 
    // call to RasPhonebookDlg will fail
    lpInfo->dwSize = sizeof(RASPBDLG);
     
    // Open a user dialog box  
    nRet = RasPhonebookDlg(NULL,NULL,lpInfo);
    
    if(nRet == TRUE){
        // The user dialed a connection successfully
        printf("User pressed Connect\n");
    }else{
        if(lpInfo->dwError != 0){
            printf("RasPhonebookDlg failed: Error = %d\n", lpInfo->dwError);
        }else{
            // The user closed the dialog box manually
            printf("User pressed Close\n");
        }
    }

    // Free the heap memory for the RASPBLDG structure
    HeapFree(GetProcessHeap(), 0, lpInfo);
    return 0;
}

Remarques

Note

L’en-tête rasdlg.h définit RasPhonebookDlg 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	rasdlg.h
bibliothèque	Rasdlg.lib
DLL	Rasdlg.dll

Voir aussi

RASPBDLG

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

fonctions de service d’accès à distance

Partager via