Función RasSetAutodialAddressA (ras.h)

Artículo
08/25/2023

La función RasSetAutodialAddress puede agregar una dirección a la base de datos de asignación AutoDial. Como alternativa, la función puede eliminar o modificar los datos asociados a una dirección existente en la base de datos.

Sintaxis

DWORD RasSetAutodialAddressA(
  [in] LPCSTR              unnamedParam1,
  [in] DWORD               unnamedParam2,
  [in] LPRASAUTODIALENTRYA unnamedParam3,
  [in] DWORD               unnamedParam4,
  [in] DWORD               unnamedParam5
);

Parámetros

[in] unnamedParam1

Puntero a una cadena terminada en null que especifica la dirección que se va a agregar, eliminar o modificar. Esta dirección puede ser una dirección IP, un nombre de host de Internet ("www.microsoft.com") o un nombre NetBIOS ("products1").

Si este parámetro es NULL, la función establece la conexión a Internet predeterminada (vea Comentarios). Si este parámetro apunta a una cadena de longitud cero, la función elimina la conexión a Internet predeterminada.

[in] unnamedParam2

Reservados; debe ser cero.

[in] unnamedParam3

Puntero a una matriz de una o varias estructuras RASAUTODIALENTRY que se van a asociar a la dirección lpszAddress . Si lpAutoDialEntries es NULL y dwcbAutoDialEntries es cero, RasSetAutodialAddress elimina todas las estructuras asociadas a lpszAddress de la base de datos de asignación.

[in] unnamedParam4

Especifica el tamaño, en bytes, del búfer lpAutoDialEntries .

[in] unnamedParam5

Especifica el número de estructuras RASAUTODIALENTRY en el búfer lpAutoDialEntries .

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
ERROR_INVALID_SIZE	El miembro dwSize de la estructura RASAUTODIALENTRY es un valor no válido.
ERROR_INVALID_PARAMETER	El parámetro lpszAddress es NULL.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	El nombre de conexión especificado en lpAutoDialEntries no existe.

Comentarios

Una dirección de la base de datos de asignación AutoDial puede tener cualquier número de entradas RASAUTODIALENTRY asociadas. Cada entrada especifica información autoDial para una ubicación de marcado TAPI determinada.

Si la dirección especificada por el parámetro lpszAddress es una dirección existente en la base de datos y el parámetro lpAutoDialEntries no es NULL, la función RasSetAutodialAddress modifica el conjunto de entradas AutoDial asociadas a la dirección. Si una entrada de la matriz lpAutoDialEntries especifica una ubicación de marcado para la que la dirección ya tiene una entrada, la función reemplaza la entrada existente por la nueva entrada. De lo contrario, la función simplemente agrega las entradas lpAutoDialEntries al conjunto de entradas de la dirección.

Si la dirección lpszAddress existe en la base de datos, lpAutoDialEntries es NULL y lpAutoDialEntries es cero, RasSetAutodialAddress elimina la dirección de la base de datos.

Si la dirección lpszAddress no existe en la base de datos, RasSetAutodialAddress agrega la dirección a la base de datos. El parámetro lpAutoDialEntries especifica las entradas AutoDial que se van a asociar a la nueva dirección.

RAS admite una conexión a Internet predeterminada que es global para el equipo local y admite una conexión a Internet predeterminada para cada usuario.

Cuando el parámetro lpszAddress es NULL y el parámetro lpAutoDialEntries especifica un nombre de conexión con una entrada, RasSetAutodialAddress establece la conexión como la conexión predeterminada a Internet. El nombre de conexión especificado en lpAutoDialEntries ya debe existir. Si no es así, se devolverá ERROR_CANNOT_FIND_PHONEBOOK_ENTRY .

Cuando el parámetro lpszAddress es una cadena de longitud cero y el parámetro lpAutoDialEntries especifica un nombre de conexión vacío con una entrada, RasSetAutodialAddress elimina la conexión a Internet predeterminada.

En las máquinas cliente que no son de dominio, si un usuario quiere establecer una conexión como conexión a Internet predeterminada y especifica una conexión "for-all-users" en el miembro szEntry de la estructura RASAUTODIALENTRY , la conexión a Internet predeterminada se establece globalmente en el equipo local. En todos los demás casos, la conexión a Internet predeterminada se establece para cada usuario de la máquina individualmente.

Es posible tener dos conexiones que tengan el mismo nombre si una está configurada como una conexión "for-all-users" y la otra está configurada como una conexión "for-me-only". Si el parámetro lpAutoDialEntries especifica un nombre de conexión que corresponde a una conexión global y por usuario, se establece la conexión por usuario.

Nota

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