Función RasGetSubEntryHandleA (ras.h)

Artículo
11/20/2024

La función RasGetSubEntryHandle recupera un identificador de conexión para un subentry especificado de una conexión de varios vínculos.

Sintaxis

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

Parámetros

[in] unnamedParam1

Especifica el identificador de conexión de HRASCONN devuelto por la función de RasDial para una entrada de libreta de teléfonos de varios vínculos.

[in] unnamedParam2

Especifica un índice de subentry válido para la entrada de la libreta de teléfonos.

[out] unnamedParam3

Puntero a la variable HRASCONN que recibe un identificador de conexión que representa la conexión de subentry.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error o un valor de Códigos de error de enrutamiento y acceso remoto o Winerror.h.

Valor	Significado
ERROR_INVALID_HANDLE	El identificador de conexión hRasConn no representa una entrada de libreta de teléfono conectada.
ERROR_PORT_NOT_OPEN	Los parámetros hRasConn y dwSubEntry son válidos, pero el subentry especificado no está conectado.
ERROR_NO_MORE_ITEMS	El valor especificado por dwSubEntry supera el número máximo de subintentos para la entrada de la libreta de teléfonos.

Observaciones

El identificador de conexión especificado en el parámetro hRasConn hace referencia a toda la conexión de varios vínculos, pero el identificador de conexión devuelto en el parámetro *lphRasConn solo hace referencia a la conexión de subentry. Use el identificador de conexión de subentry en cualquier función que acepte un parámetro hRasConn, incluidos los RasHangUp, RasGetConnectStatusy funciones de RasGetProjectionInfoEx. La información de proyección devuelta por RasGetProjectionInfo para una entrada de varios vínculos es la misma para cada uno de los identificadores de conexión de subentry que para el identificador de conexión principal.

Puede llamar a RasHangUp en el identificador devuelto por RasGetSubEntryHandle para finalizar un único vínculo en una conexión de varios vínculos. Sin embargo, no puede usar rasGetConnectStatus para determinar si el vínculo finalizó; rasGetConnectStatus puede que no devuelva ERROR_INVALID_HANDLE aunque el vínculo finalice correctamente.

Nota

El encabezado ras.h define RasGetSubEntryHandle como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	ras.h
biblioteca de	Rasapi32.lib
DLL de	Rasapi32.dll