Función WNetCancelConnection2A (winnetwk.h)

Artículo
08/27/2023

La función WNetCancelConnection2 cancela una conexión de red existente. También puede llamar a la función para quitar las conexiones de red recordadas que no están conectadas actualmente.

La función WNetCancelConnection2 sustituye a la función WNetCancelConnection .

Sintaxis

DWORD WNetCancelConnection2A(
  [in] LPCSTR lpName,
  [in] DWORD  dwFlags,
  [in] BOOL   fForce
);

Parámetros

[in] lpName

Puntero a una cadena terminada en null constante que especifica el nombre del dispositivo local redirigido o del recurso de red remoto del que se va a desconectar.

Si este parámetro especifica un dispositivo local redirigido, la función cancela solo el redireccionamiento del dispositivo especificado. Si el parámetro especifica un recurso de red remota, se cancelan todas las conexiones sin dispositivos.

[in] dwFlags

Tipo de conexión. Se definen los valores siguientes.

Valor	Significado
0	El sistema no actualiza información sobre la conexión. Si la conexión se marcó como persistente en el Registro, el sistema continúa restaurando la conexión en el siguiente inicio de sesión. Si la conexión no se marcó como persistente, la función omite la configuración de la marca CONNECT_UPDATE_PROFILE.
CONNECT_UPDATE_PROFILE	El sistema actualiza el perfil de usuario con la información que la conexión ya no es persistente. El sistema no restaurará esta conexión durante las operaciones de inicio de sesión posteriores. (Desconectar recursos mediante nombres remotos no tiene ningún efecto en las conexiones persistentes).

[in] fForce

Especifica si debe producirse la desconexión si hay archivos abiertos o trabajos en la conexión. Si este parámetro es FALSE, se produce un error en la función si hay archivos abiertos o trabajos.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es un código de error del sistema, como uno de los siguientes valores.

Código devuelto	Descripción
ERROR_BAD_PROFILE	El perfil de usuario tiene un formato incorrecto.
ERROR_CANNOT_OPEN_PROFILE	El sistema no puede abrir el perfil de usuario para procesar conexiones persistentes.
ERROR_DEVICE_IN_USE	Hay un proceso activo que usa el dispositivo y no se puede desconectar.
ERROR_EXTENDED_ERROR	Error específico de la red. Para obtener una descripción del error, llame a la función WNetGetLastError .
ERROR_NOT_CONNECTED	El nombre especificado por el parámetro lpName no es un dispositivo redirigido o el sistema no está conectado actualmente al dispositivo especificado por el parámetro .
ERROR_OPEN_FILES	Hay archivos abiertos y el parámetro fForce es FALSE.

Comentarios

Windows Server 2003 y Windows XP: Las funciones WNet crean y eliminan letras de unidad de red en el espacio de nombres de dispositivo MS-DOS asociado a una sesión de inicio de sesión porque los dispositivos MS-DOS se identifican mediante AuthenticationID. (Un AuthenticationID es el identificador único local o LUID, asociado a una sesión de inicio de sesión). Esto puede afectar a las aplicaciones que llaman a una de las funciones de WNet para crear una letra de unidad de red en un inicio de sesión de usuario, pero consultar las letras de unidad de red existentes en un inicio de sesión de usuario diferente. Un ejemplo de esta situación podría ser cuando se crea el segundo inicio de sesión de un usuario en una sesión de inicio de sesión, por ejemplo, llamando a la función CreateProcessAsUser y el segundo inicio de sesión ejecuta una aplicación que llama a la función GetLogicalDrives . GetLogicalDrives no devuelve letras de unidad de red creadas por una función WNet en el primer inicio de sesión. Tenga en cuenta que en el ejemplo anterior todavía existe la primera sesión de inicio de sesión y el ejemplo podría aplicarse a cualquier sesión de inicio de sesión, incluida una sesión de Terminal Services. Para obtener más información, consulte Definición de un nombre de dispositivo MS-DOS.

Ejemplos

Para obtener un ejemplo de código que muestra cómo cancelar una conexión a un recurso de red con una llamada a la función WNetCancelConnection2 , consulte Cancelar una conexión de red.

Nota:

El encabezado winnetwk.h define WNetCancelConnection2 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


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	winnetwk.h
Library	Mpr.lib
Archivo DLL	Mpr.dll