Función RasSetEntryPropertiesA (ras.h)

Artículo
11/20/2024

La función RasSetEntryProperties cambia la información de conexión de una entrada de la libreta de teléfonos o crea una nueva entrada de libreta de teléfonos.

Sintaxis

DWORD RasSetEntryPropertiesA(
  [in] LPCSTR      unnamedParam1,
  [in] LPCSTR      unnamedParam2,
  [in] LPRASENTRYA unnamedParam3,
  [in] DWORD       unnamedParam4,
  [in] LPBYTE      unnamedParam5,
  [in] DWORD       unnamedParam6
);

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é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.

[in] unnamedParam2

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

Si el nombre de entrada coincide con una entrada existente, RasSetEntryProperties modifica las propiedades de esa entrada.

Si el nombre de la entrada no coincide con una entrada existente, RasSetEntryProperties crea una nueva entrada de libreta de teléfonos. Para las nuevas entradas, llame a la función rasValidateEntryName para validar el nombre de entrada antes de llamar a RasSetEntryProperties.

[in] unnamedParam3

Puntero a la estructura RASENTRY que especifica los nuevos datos de conexión que se van a asociar a la entrada de la libreta de teléfonos indicada por el parámetro lpszEntry.

El autor de la llamada debe proporcionar valores para los siguientes miembros de la estructura de RASENTRY.

dwSize
szLocalPhoneNumber
szDeviceName
szDeviceType
dwFramingProtocol
dwfOptions
dwType

Windows XP o posterior: se admite dwType.

Si no se proporcionan valores para estos miembros, rasSetEntryProperties produce un error con ERROR_INVALID_PARAMETER.

La estructura puede ir seguida de una matriz de cadenas de números de teléfono alternativos terminadas en NULL. La última cadena finaliza con dos caracteres NULOs consecutivos. El miembro dwAlternateOffset del RASENTRY contiene el desplazamiento a la primera cadena.

[in] unnamedParam4

Especifica el tamaño, en bytes, del búfer identificado por el parámetro lpRasEntry.

[in] unnamedParam5

Puntero a un búfer que especifica información de configuración específica del dispositivo. Esta es información opaca de configuración del dispositivo TAPI. Para obtener más información sobre la configuración del dispositivo TAPI, consulte la función lineGetDevConfig en interfaces de programación de aplicaciones de telefonía (TAPI) en el SDK de plataforma.

Windows XP: Este parámetro no se usa. La función de llamada debe establecer este parámetro en NULL.

[in] unnamedParam6

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

Windows XP: Este parámetro no se usa. La función de llamada debe establecer este parámetro en cero.

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_ACCESS_DENIED	El usuario no tiene los privilegios correctos. Solo un administrador puede completar esta tarea.
ERROR_BUFFER_INVALID	La dirección o el búfer especificados por lpRasEntry no es válido.
ERROR_CANNOT_OPEN_PHONEBOOK	La libreta de teléfonos está dañada o faltan componentes.
ERROR_INVALID_PARAMETER	La estructura RASENTRY apuntada por el parámetro lpRasEntry no contiene información adecuada o la entrada especificada no existe en la libreta de teléfonos. Consulte la descripción de lpRasEntry para ver qué información es necesaria.

Observaciones

Al establecer propiedades para una conexión de todos los usuarios, si la aplicación que realiza la llamada especifica un valor que no esNULL para el parámetro de la libreta de teléfonos, lpszPhonebook, el archivo de libreta de teléfonos debe encontrarse en el directorio de libreta de teléfonos debajo de la ruta de acceso de datos de la aplicación todos los usuarios. Para obtener la ubicación correcta para el archivo de libreta de teléfonos, primero llame a SHGetFolderPath con un CSIDL valor de CSIDL_COMMON_APPDATA. SHGetFolderPath devuelve la ruta de acceso de datos de la aplicación todos los usuarios. Anexe la cadena siguiente a esta ruta de acceso:

Microsoft\Network\Connections\Pbk

La ruta de acceso combinada es la ubicación correcta para el archivo de la libreta de teléfonos.

Nota Especificar un valor de NULL que no seapara el parámetro lpszPhonebook no se admite en versiones de Windows posteriores a Windows XP.

Nota

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