Fonction RasPhonebookDlgA (rasdlg.h)

La fonction RasPhonebookDlg affiche la boîte de dialogue Mise en réseau à distance main. À partir de cette boîte de dialogue modale, l’utilisateur peut composer, modifier ou supprimer une entrée de carnet de téléphone sélectionnée, créer une nouvelle entrée de carnet de téléphone 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 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 .

[in] lpszEntry

Pointeur vers une chaîne terminée par null qui spécifie le nom de l’entrée de l’annuaire téléphonique à mettre en surbrillance initialement. Si ce paramètre a la valeur 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 sizeof( RASPBDLG).

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

Valeur retournée

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

Si une erreur se produit, le membre dwError de la structure RASPBDLG retourne une valeur à partir 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 à distance . La boîte de dialogue affiche les informations de numérotation de la première entrée du fichier de répertoire 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;
}

Notes

Notes

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. 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.

Spécifications

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	rasdlg.h
Bibliothèque	Rasdlg.lib
DLL	Rasdlg.dll

Voir aussi

RASPBDLG

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

Fonctions du service d’accès à distance