Функция RasPhonebookDlgA (rasdlg.h)

Статья
08/25/2023

Функция RasPhonebookDlg отображает диалоговое окно main Коммутируемая сеть. В этом модальном диалоговом окне пользователь может набрать, изменить или удалить выбранную запись телефонной книги, создать новую запись телефонной книги или указать параметры пользователя. Функция RasPhonebookDlg возвращает значение при закрытии диалогового окна.

Синтаксис

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

Параметры

[in] lpszPhonebook

Указатель на строку, завершающуюся null, которая указывает полный путь и имя файла телефонной книги (PBK). Если этот параметр имеет значение NULL, функция использует текущий файл телефонной книги по умолчанию. Файл телефонной книги по умолчанию — это файл, выбранный пользователем на странице свойств Пользовательские настройки диалогового окна Сеть с телефонным подключением .

[in] lpszEntry

Указатель на строку, завершающуюся значением NULL, которая указывает имя записи телефонной книги для первоначального выделения. Если этот параметр имеет значение NULL или указанная запись не существует, диалоговое окно выделяет первую запись в алфавитном списке.

[in, out] lpInfo

Указатель на структуру RASPBDLG , которая задает дополнительные входные и выходные параметры.

Во входных данных член dwSize этой структуры должен указывать sizeof( RASPBDLG).

При возникновении ошибки член dwError структуры получает в выходных данных код ошибки; в противном случае он получает ноль.

Возвращаемое значение

Если пользователь нажимает кнопку Подключиться и функция устанавливает соединение, возвращается значение TRUE. В противном случае функция возвращает значение FALSE.

При возникновении ошибки член dwError структуры RASPBDLG возвращает значение из кода ошибок маршрутизации и удаленного доступа или Winerror.h.

В следующем примере кода открывается диалоговое окно Сети с телефонным подключением . В диалоговом окне отображаются сведения о наборе номера для первой записи из файла телефонной книги по умолчанию.

#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;
}

Заголовок rasdlg.h определяет RasPhonebookDlg как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	rasdlg.h
Библиотека	Rasdlg.lib
DLL	Rasdlg.dll

См. также раздел

RASPBDLG

Обзор службы удаленного доступа (RAS)

Функции службы удаленного доступа