Função RasGetSubEntryPropertiesA (ras.h)

Artigo
03/05/2024

A função RasGetSubEntryProperties recupera informações sobre uma subentidade para uma entrada de catálogo telefônico 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 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 o nome de uma entrada existente na lista telefônica.

[in] unnamedParam3

Especifica o índice baseado em um da subentidade.

[in, out] unnamedParam4

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

Na saída, a estrutura recebe informações sobre a subentidade 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).

Este parâmetro pode ser NULL.

[in, out] unnamedParam5

Ponteiro para uma variável que especifica, na entrada, o tamanho, em bytes, do buffer 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 for NULL.

[in] unnamedParam6

Ponteiro para um bloco de configuração de dispositivo TAPI. No momento, esse parâmetro não é 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 linha de funçãoGetDevConfig.

[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 é usado. O chamador deve passar NULL para esse parâmetro.

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_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 do catálogo telefônico não existe.

Comentários

Uma entrada de catálogo telefônico ras pode ter zero ou mais subentidades, cada uma minimamente consistindo em um dispositivo e um número de telefone. Uma entrada de catálogo telefônico com várias subentidades pode ser configurada para discar as primeiras subentidades disponíveis ou todas 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 catálogo telefônico. O membro dwSubEntries indica o número de subentidades e o membro dwDialMode indica a configuração de discagem.

Observação

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