Función RasGetEntryDialParamsA (ras.h)

Artículo
11/20/2024

La función RasGetEntryDialParams recupera la información de conexión guardada por la última llamada correcta a la RasDial o RasSetEntryDialParams función para una entrada de libreta de teléfono especificada.

Sintaxis

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

Parámetros

[in] unnamedParam1

Puntero a un cadena terminada en nullque especifica la ruta de acceso completa y el nombre de archivo de un archivo de libreta telefónica (PBK). Si este parámetro es NULL, la función usa el archivo de libreta de teléfono predeterminado actual. El archivo de libreta de teléfonos predeterminado es el seleccionado por el usuario en la hoja de propiedades preferencias de usuario de del cuadro de diálogo Redes de acceso telefónico.

Windows Me/98/95: Este parámetro siempre debe ser NULL. Las redes de acceso telefónico almacenan entradas de libreta de teléfonos en el registro en lugar de en un archivo de libreta de teléfonos.

[in, out] unnamedParam2

Puntero a una estructura de RASDIALPARAMS.

En la entrada, el miembro dwSize especifica el tamaño de la estructura de RASDIALPARAMS y el miembro szEntryName especifica una entrada de libreta de teléfono válida.

En la salida, la estructura recibe los parámetros de conexión asociados a la entrada de la libreta de teléfono especificada.

Tenga en cuenta que el szPhoneNumber miembro de la estructura no recibe el número de teléfono asociado a la entrada de la libreta de teléfonos. Para obtener el número de teléfono asociado a una entrada de libreta de teléfonos, llame a la función RasGetEntryProperties. Si szPhoneNumber es una cadena vacía en la estructura RASDIALPARAMS de pasada a RasDial, RasDial usa el número de teléfono almacenado en la entrada de la libreta de teléfonos.

El szPassword miembro del RASDIALPARAMS estructura no devuelve la contraseña real. En su lugar, szPassword contiene un identificador para la contraseña guardada. Sustituya este identificador por la contraseña guardada en llamadas posteriores a RasSetEntryDialParams y RasDial. Cuando se presenta este identificador, rasDial recupera y usa la contraseña guardada. El valor de este identificador puede cambiar en versiones futuras del sistema operativo; no desarrolle código que dependa del contenido o el formato de este valor.

Windows NT y Windows Me/98/95: no se admite característica de contraseña segura.

[out] unnamedParam3

Puntero a una marca que indica si la función recuperó la contraseña asociada al nombre de usuario para la entrada de la libreta de teléfonos. El parámetro lpfPassword es TRUE si el sistema ha guardado una contraseña para la entrada especificada. Si el sistema no tiene ninguna contraseña guardada para esta entrada, lpfPassword es FALSE.

Windows NT y Windows Me/98/95: La función establece esta marca en TRUE si se devolvió la contraseña del usuario en el szPassword miembro del RASDIALPARAMS que apunta lprasdialparams.

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	Descripción
ERROR_BUFFER_INVALID	El lprasdialparams o puntero lpfPassword no es válido o el búfer de lprasdialparams no es válido.
ERROR_CANNOT_OPEN_PHONEBOOK	La libreta de teléfonos está dañada o faltan componentes.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	La entrada de la libreta de teléfonos no existe.

Observaciones

Nota

El encabezado ras.h define RasGetEntryDialParams 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