Função RasPhonebookDlgA (rasdlg.h)

Artigo
11/20/2024

A função RasPhonebookDlg exibe a caixa de diálogo principal rede discada. Nessa caixa de diálogo modal, o usuário pode discar, editar ou excluir uma entrada de lista telefônica selecionada, criar uma nova entrada de lista telefônica ou especificar preferências do usuário. A função RasPhonebookDlg retorna quando a caixa de diálogo é fechada.

Sintaxe

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

Parâmetros

[in] lpszPhonebook

Ponteiro para um cadeia de caracteres nulaterminada que especifica o caminho completo e o nome do arquivo de um arquivo PBK (phone-book). Se esse parâmetro for NULL, a função usará o arquivo de agendamento telefônico padrão atual. O arquivo de lista telefônica padrão é o selecionado pelo usuário na folha de propriedades preferências do usuário da caixa de diálogo rede discada .

[in] lpszEntry

Ponteiro para um cadeia de caracteresterminada nula que especifica o nome da entrada da lista telefônica a ser realçada inicialmente. Se esse parâmetro for NULL ou se a entrada especificada não existir, a caixa de diálogo destacará a primeira entrada na lista alfabética.

[in, out] lpInfo

Ponteiro para a estrutura RASPBDLG que especifica parâmetros adicionais de entrada e saída.

Na entrada, o dwSize membro dessa estrutura deve especificar o sizeof( RASPBDLG).

Se ocorrer um erro, o dwError membro da estrutura receberá, na saída, um código de erro; caso contrário, ele receberá zero.

Valor de retorno

Se o usuário selecionar o botão Conectar e a função estabelecer uma conexão, o valor retornado será VERDADEIRO. Caso contrário, a função retornará FALSE.

Se ocorrer um erro, o dwError membro da estrutura RASPBDLG retornará um valor de códigos de erro de roteamento e acesso remoto ou Winerror.h.

O código de exemplo a seguir apresenta a caixa de diálogo rede discada . A caixa de diálogo exibe informações de discagem para a primeira entrada do arquivo de pasta de telefone padrão.

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

Observações

Nota

O cabeçalho rasdlg.h define RasPhonebookDlg como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	rasdlg.h
biblioteca	Rasdlg.lib
de DLL	Rasdlg.dll

Consulte também

RASPBDLG

Visão geral do RAS (Serviço de Acesso Remoto)

Funções do Serviço de Acesso Remoto

Compartilhar via