Função RasGetSubEntryHandleA (ras.h)

Artigo
11/20/2024

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 lista telefônica multilink.

[in] unnamedParam2

Especifica um índice de subentrada válido para a entrada da lista telefônica.

[out] unnamedParam3

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

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_HANDLE	O identificador de conexão hRasConn não representa uma entrada de lista telefônica conectada.
ERROR_PORT_NOT_OPEN	Os parâmetros e dwSubEntry hRasConn 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 da lista telefônica.

Observações

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, RasGetConnectStatuse RasGetProjectionInfoEx. As informações de projeção retornadas por RasGetProjectionInfo para uma entrada multilink é a mesma para cada um dos identificadores de conexão de subentrada que é para o identificador de conexão principal.

Você pode chamar RasHangUp no identificador retornado pelo rasGetSubEntryHandle para encerrar um único link em uma conexão de vários vínculos. 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 terminado com êxito.

Nota

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

RasDial

rasGetConnectStatus

RasGetProjectionInfoEx

RasHangUp

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

Funções do Serviço de Acesso Remoto

Compartilhar via