Função RasGetEntryPropertiesA (ras.h)

A função RasGetEntryProperties recupera as propriedades de uma entrada de catálogo telefônico.

Sintaxe

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     unnamedParam6
);

Parâmetros

[in] unnamedParam1

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o caminho completo e o nome do arquivo de um arquivo de catálogo telefônico (PBK). Se esse parâmetro for NULL, a função usará o arquivo de catálogo telefônico padrão atual. O arquivo de agendamento telefônico padrão é aquele selecionado pelo usuário na folha de propriedades Preferências do Usuário da caixa de diálogo Rede Discada .

Windows Me/98/95: Esse parâmetro sempre deve ser NULL. A rede discada armazena entradas de catálogo telefônico no registro em vez de em um arquivo de agendamento telefônico.

[in] unnamedParam2

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica um nome de entrada existente. Se uma cadeia de caracteres vazia for especificada, a função retornará valores padrão nos buffers apontados pelos parâmetros lpRasEntry e lpbDeviceInfo .

[in, out] unnamedParam3

Ponteiro para uma estrutura RASENTRY seguida por bytes adicionais para a lista de números de telefone alternativos, se houver um.

Na saída, a estrutura recebe os dados de conexão associados à entrada do catálogo telefônico especificada pelo parâmetro lpszEntry .

Na entrada, defina o membro dwSize da estrutura como sizeof (RASENTRY) para identificar a versão da estrutura.

Este parâmetro pode ser NULL.

Windows Me/98 e Windows 95 OSR2: A Camada da Microsoft para Unicode não dá suporte a dwAlternateOffset em RASENTRY.

[in, out] unnamedParam4

Ponteiro para uma variável que, na entrada, especifica o tamanho, em bytes, do buffer lpRasEntry .

Na saída, essa variável recebe o número de bytes necessários.

Esse parâmetro poderá ser NULL se o parâmetro lpRasEntry for NULL.

Para determinar o tamanho do buffer necessário, chame RasGetEntryProperties com lpRasEntry definido como NULL e *lpdwEntryInfoSize definido como zero. A função retorna o tamanho do buffer necessário em *lpdwEntryInfoSize.

[out] unnamedParam5

Esse parâmetro não é mais usado. A função de chamada deve definir esse parâmetro como NULL.

Windows Me/98/95: Ponteiro para um buffer que recebe informações de configuração específicas do dispositivo. Não manipule diretamente essas informações opacas do dispositivo TAPI. Para obter mais informações sobre a configuração do dispositivo TAPI, consulte a função lineGetDevConfig na Referência do Programador TAPI no SDK da Plataforma.

Este parâmetro pode ser NULL.

[in, out] unnamedParam6

Esse parâmetro não está em uso. A função de chamada deve definir esse parâmetro como NULL.

Windows Me/98/95: Ponteiro para uma variável que, na entrada, especifica o tamanho, em bytes, do buffer especificado pelo parâmetro lpbDeviceInfo .

Na saída, essa variável recebe o número de bytes necessários.

Esse parâmetro poderá ser NULL se o parâmetro lpbDeviceInfo for NULL.

Para determinar o tamanho do buffer necessário, chame RasGetEntryProperties com lpbDeviceInfo definido como NULL e *lpdwDeviceInfoSize definido como zero. A função retorna o tamanho do buffer necessário em *lpdwDeviceInfoSize.

Retornar valor

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro ou um valor de Códigos de Erro de Roteamento e Acesso Remoto ou Winerror.h.

Valor	Significado
ERROR_INVALID_PARAMETER	A função foi chamada com um parâmetro inválido.
ERROR_INVALID_SIZE	O valor do membro dwSize do lpRasEntry é muito pequeno.
ERROR_BUFFER_INVALID	O endereço ou buffer especificado por lpRasEntry é inválido.
ERROR_BUFFER_TOO_SMALL	O tamanho do buffer indicado em lpdwEntryInfoSize é muito pequeno.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	A entrada do catálogo telefônico não existe ou o arquivo de agendamento telefônico está corrompido e/ou tem componentes ausentes.

Comentários

Observação

O cabeçalho ras.h define RasGetEntryProperties como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ras.h
Biblioteca	Rasapi32.lib
DLL	Rasapi32.dll

Confira também

RASENTRY

Rassetentryproperties

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

Funções do serviço de acesso remoto