Función RasGetEapUserIdentityA (ras.h)

Artículo
03/01/2024

La función RasGetEapUserIdentity recupera información de identidad para el usuario actual. Use esta información para llamar a RasDial con una entrada de libreta de teléfonos que requiera el Protocolo de autenticación extensible (EAP).

Sintaxis

DWORD RasGetEapUserIdentityA(
  [in]  LPCSTR                pszPhonebook,
  [in]  LPCSTR                pszEntry,
  [in]  DWORD                 dwFlags,
  [in]  HWND                  hwnd,
  [out] LPRASEAPUSERIDENTITYA *ppRasEapUserIdentity
);

Parámetros

[in] pszPhonebook

Puntero a una cadena terminada en null que especifica la ruta de acceso completa del archivo de libreta telefónica (PBK). Si este parámetro es NULL, la función usa la libreta telefónica del sistema.

[in] pszEntry

Puntero a una cadena terminada en null que especifica un nombre de entrada existente.

[in] dwFlags

Especifica cero o más de las marcas siguientes que califican el proceso de autenticación.

Marca	Significado
RASEAPF_NonInteractive	Especifica que el protocolo de autenticación no debe mostrar una interfaz gráfica de usuario. Si esta marca no está presente, está bien para que el protocolo muestre una interfaz de usuario.
RASEAPF_Logon	Especifica que los datos de usuario se obtienen de WinLogon.
RASEAPF_Preview	Especifica que se debe solicitar al usuario información de identidad antes de marcar.

[in] hwnd

Identificador de la ventana primaria del cuadro de diálogo de la interfaz de usuario. Si el parámetro fInvokeUI es FALSE, hwnd debe ser NULL.

[out] ppRasEapUserIdentity

Puntero a un puntero que, al devolverse correctamente, recibe la dirección de la estructura RASEAPUSERIDENTITY que contiene información de identidad de usuario de EAP. RasGetEapUserIdentity asigna el búfer de memoria para la estructura RASEAPUSERIDENTITY . Libere esta memoria llamando a RasFreeEapUserIdentity.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto se 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
E_INVALID_ARG	El parámetro pcbEapUserIdentity es NULL.
ERROR_INTERACTIVE_MODE	Se llamó a la función con la marca RASEAPF_NonInteractive. Sin embargo, el protocolo de autenticación debe mostrar una interfaz de usuario para obtener la información de identidad necesaria del usuario.
ERROR_INVALID_FUNCTION_FOR_ENTRY	El método de autenticación para esta entrada de libreta de teléfonos no es EAP o el método de autenticación es EAP, pero el protocolo usa el cuadro de diálogo estándar de credenciales de Windows NT/Windows 2000 para obtener información de identidad de usuario. En cualquier caso, el autor de la llamada no necesita pasar información de identidad de EAP a RasDial.
ERROR_RASMAN_CANNOT_INITIALIZE	El servicio de acceso remoto no se pudo inicializar correctamente.
Otros	Use FormatMessage para recuperar el mensaje de error del sistema que corresponde al código de error devuelto.

Comentarios

RasGetEapUserIdentity llama a la función RASGetEapUserData y a la función de EAP RasEapGetIdentity. RasEapGetIdentity se implementa mediante el protocolo de autenticación.

Si la función se realiza correctamente, es decir, el valor devuelto es NO_ERROR, el autor de la llamada debe copiar la información de identidad de EAP de la estructura RASEAPUSERIDENTITY a la que apunta el parámetro ppRasEapUserIdentity a las estructuras RASDIALPARAMS y RASDIALEXTENSIONS usadas en la llamada a RasDial.

Si la aplicación de acceso remoto que se está desarrollando tiene una interfaz gráfica de usuario, el autor de la llamada de RasGetEapUserIdentity no debe especificar la marca RASEAPF_NonInteractive. Si la aplicación tiene una interfaz de usuario de línea de comandos, es posible que el autor de la llamada quiera especificar la marca RASEAPF_NonInteractive para evitar que el protocolo de autenticación muestre una interfaz gráfica de usuario.

Nota

El encabezado ras.h define RasGetEapUserIdentity 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 Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	ras.h
Library	Rasapi32.lib
Archivo DLL	Rasapi32.dll