Função RasGetSubEntryPropertiesA (ras.h)

Artigo
11/20/2024

A função RasGetSubEntryProperties recupera informações sobre uma subentrada para uma entrada de lista telefônica especificada.

Sintaxe

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        unnamedParam7
);

Parâmetros

[in] unnamedParam1

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 .

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

[in] unnamedParam2

Ponteiro para um cadeia de caracteresterminada nula que especifica o nome de uma entrada existente na lista telefônica.

[in] unnamedParam3

Especifica o índice baseado em um da subentrada.

[in, out] unnamedParam4

Ponteiro para a estrutura de RASSUBENTRY seguida de bytes adicionais para a lista de números de telefone alternativo, se houver uma.

Na saída, a estrutura recebe informações sobre a subentrada especificada.

Na entrada, o membro dwSize especifica o tamanho da estrutura. O tamanho identifica a versão da estrutura. Obtenha esse tamanho usando sizeof(RASSUBENTRY).

Esse parâmetro pode ser NULL.

[in, out] unnamedParam5

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

Na saída, a variável recebe o número de bytes retornados ou o número de bytes necessários se o buffer for muito pequeno.

Esse parâmetro poderá ser NULL se lpRasSubEntry estiver NULL.

[in] unnamedParam6

Ponteiro para um bloco de configuração de dispositivo TAPI. No momento, esse parâmetro não foi usado. O chamador deve passar NULL para esse parâmetro. Para obter mais informações sobre os blocos de configuração do dispositivo TAPI, consulte a função lineGetDevConfig.

[in] unnamedParam7

Ponteiro para um DWORD que especifica o tamanho do bloco de configuração do dispositivo TAPI. No momento, esse parâmetro não foi usado. O chamador deve passar NULL para esse parâmetro.

Valor de retorno

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_BUFFER_INVALID	O endereço ou buffer especificado por lpRasSubEntry é inválido.
ERROR_BUFFER_TOO_SMALL	O buffer lpRasSubEntry é muito pequeno. A variável lpdwcb recebe o tamanho do buffer necessário.
ERROR_CANNOT_OPEN_PHONEBOOK	A lista telefônica está corrompida ou está faltando componentes.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	A entrada da lista telefônica não existe.

Observações

Uma entrada de lista telefônica RAS pode ter zero ou mais subentidades, cada uma consistindo minimamente de um dispositivo e um número de telefone. Uma entrada de lista telefônica com várias subentidades pode ser configurada para discar a primeira disponível ou todas as subentidades quando a entrada é discada.

Use a função RasGetEntryProperties para recuperar uma estrutura RASENTRY que contém informações sobre as subentidades de uma entrada de lista telefônica. O membro dwSubEntries indica o número de subentidades e o membro dwDialMode indica a configuração de discagem.

Nota

O cabeçalho ras.h define RasGetSubEntryProperties 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	ras.h
biblioteca	Rasapi32.lib
de DLL	Rasapi32.dll

Consulte também

RASENTRY

RASSUBENTRY

RasGetEntryProperties

RasSetSubEntryProperties

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

Funções do Serviço de Acesso Remoto

Compartilhar via