Función WNetCancelConnectionA (winnetwk.h)

Artículo
08/27/2023

La función WNetCancelConnection cancela una conexión de red existente.

La función WNetCancelConnection se proporciona por compatibilidad con versiones de 16 bits de Windows. Otras aplicaciones basadas en Windows deben llamar a la función WNetCancelConnection2 .

Sintaxis

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

Parámetros

[in] lpName

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

Cuando este parámetro especifica un dispositivo local redirigido, la función cancela solo la redirección de dispositivos especificada. Si el parámetro especifica un recurso de red remota, solo se cancelan las conexiones a redes remotas sin dispositivos.

[in] fForce

Especifica si se debe producir o no 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 o trabajos abiertos.

Valor devuelto

Si la función se realiza 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 valores siguientes.

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 del 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 bajo 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 bajo 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, vea Definición de un nombre de dispositivo MS-DOS.

Nota

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