Função RasGetSubEntryHandleA (ras.h)

Artigo
08/25/2023

A função RasGetSubEntryHandle recupera um identificador de conexão para uma subentidade especificada de uma conexão multilink.

Sintaxe

DWORD RasGetSubEntryHandleA(
  [in]  HRASCONN   unnamedParam1,
  [in]  DWORD      unnamedParam2,
  [out] LPHRASCONN unnamedParam3
);

Parâmetros

[in] unnamedParam1

Especifica o identificador de conexão HRASCONN retornado pela função RasDial para uma entrada de catálogo telefônico multilink.

[in] unnamedParam2

Especifica um índice de subentrada válido para a entrada do catálogo telefônico.

[out] unnamedParam3

Ponteiro para a variável HRASCONN que recebe um identificador de conexão que representa a conexão de subentrada.

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_HANDLE	O identificador de conexão hRasConn não representa uma entrada de lista telefônica conectada.
ERROR_PORT_NOT_OPEN	Os parâmetros hRasConn e dwSubEntry são válidos, mas a subentidade especificada não está conectada.
ERROR_NO_MORE_ITEMS	O valor especificado por dwSubEntry excede o número máximo de subentidades para a entrada do catálogo telefônico.

Comentários

O identificador de conexão especificado no parâmetro hRasConn refere-se a toda a conexão multilink, mas o identificador de conexão retornado no parâmetro *lphRasConn refere-se apenas à conexão de subentrada. Use o identificador de conexão de subentrada em qualquer função que aceite um parâmetro hRasConn , incluindo as funções RasHangUp, RasGetConnectStatus e RasGetProjectionInfoEx . As informações de projeção retornadas por RasGetProjectionInfo para uma entrada multilink são as mesmas para cada um dos identificadores de conexão de subentrada que são para o identificador de conexão main.

Você pode chamar RasHangUp no identificador retornado por RasGetSubEntryHandle para encerrar um único link em uma conexão de vários links. No entanto, você não pode usar RasGetConnectStatus para determinar se o link foi encerrado; RasGetConnectStatus pode não retornar ERROR_INVALID_HANDLE mesmo que o link tenha sido encerrado com êxito.

Observação

O cabeçalho ras.h define RasGetSubEntryHandle 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