Función RasSetEntryDialParamsA (ras.h)

Artículo
03/01/2024

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

Sintaxis

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             unnamedParam3
);

Parámetros

[in] unnamedParam1

Puntero a una cadena terminada en null que especifica la ruta de acceso completa y el nombre de archivo de un archivo de libreta de teléfonos (PBK). Si este parámetro es NULL, la función usa el archivo de libreta de teléfonos predeterminado actual. El archivo de libreta telefónica predeterminado es el seleccionado por el usuario en la hoja de propiedades Preferencias de usuario 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] unnamedParam2

Puntero a la estructura RASDIALPARAMS que especifica los parámetros de conexión que se van a asociar a la entrada de la libreta de teléfonos. RasSetEntryDialParams usa los miembros de la estructura de la siguiente manera.

Miembro	Significado
dwSize	Debe especificar el tamaño de (RASDIALPARAMS) para identificar la versión de la estructura.
szEntryName	Cadena terminada en null que identifica la entrada de la libreta de teléfonos para la que se van a establecer parámetros.
szPhoneNumber	No se usa. Se establece en NULL.
szCallbackNumber	Cadena terminada en null que contiene el número de teléfono de devolución de llamada. Si szCallbackNumber es una cadena vacía ( "", no se cambia el número de devolución de llamada.
szUserName	Cadena terminada en null que contiene el nombre de inicio de sesión del usuario asociado a esta entrada. Si szUserName es una cadena vacía, el nombre de usuario no cambia.
szPassword	Cadena terminada en null que contiene la contraseña del usuario especificado por szUserName. Si szUserName es una cadena vacía, la contraseña no cambia. Si szPassword es una cadena vacía y fRemovePassword es FALSE, la contraseña se establece en la cadena vacía. Si fRemovePassword es TRUE, la contraseña almacenada en esta entrada de libreta de teléfonos para el usuario especificado por szUserName se quita independientemente del contenido de la cadena szPassword . Windows NT 4.0: La contraseña se cambia a la cadena especificada por szPassword independientemente de si szUserName es una cadena vacía. Windows XP/2000: Si szPassword contiene el identificador de contraseña devuelto por RasGetCredentials o RasGetEntryDialParams, RasSetEntryDialParams devuelve correctamente sin cambiar ninguna contraseña guardada actualmente.
szDomain	Cadena terminada en null que contiene el nombre del dominio en el que se va a iniciar sesión. Si szDomain es una cadena vacía, el nombre de dominio no cambia.
dwSubEntry	Especifica el índice (basado en uno) del subentry inicial que se va a marcar al establecer la conexión.
dwCallbackId	Especifica un valor definido por la aplicación que RAS pasa a la función de devolución de llamada RasDialFunc2 .

[in] unnamedParam3

Especifica si se va a quitar la contraseña almacenada de la entrada de la libreta de teléfonos para el usuario indicado por lprasdialparams-szUserName>. Si fRemovePassword es TRUE, se quita la contraseña. Establecer fRemovePassword en TRUE equivale a activar la casilla "Desguardar contraseña" en Redes de acceso telefónico. Al establecer la contraseña u otras propiedades de una entrada de libreta de teléfonos, establezca fRemovePassword en FALSE.

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 Enrutamiento y códigos de error de acceso remoto o Winerror.h.

Valor	Descripción
ERROR_BUFFER_INVALID	La dirección o el búfer especificados por lprasdialparams no son válidos .
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.

Comentarios

Para crear una nueva entrada de libreta de teléfonos, use la función RasSetEntryProperties .

Windows XP o posterior: No use la función RasSetEntryDialParams . Para establecer las credenciales de una entrada de libreta de teléfonos, use la función RasSetCredentials . Establezca los miembros no credenciales de RASDIALPARAMS (por ejemplo , szCallbackNumber, dwSubEntry o dwCallbackId) directamente en la estructura RASDIALPARAMS que se pasa como parámetro a la función RasDial .

Nota

El encabezado ras.h define RasSetEntryDialParams 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en 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