Функция WNetCancelConnectionA (winnetwk.h)

Статья
08/27/2023

Функция WNetCancelConnection отменяет существующее сетевое подключение.

Функция WNetCancelConnection предоставляется для совместимости с 16-разрядными версиями Windows. Другие приложения windows должны вызывать функцию WNetCancelConnection2 .

Синтаксис

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

Параметры

[in] lpName

Указатель на константную строку, завершающуюся значением NULL, которая указывает имя перенаправленного локального устройства или удаленного сетевого ресурса для отключения.

Если этот параметр указывает перенаправленное локальное устройство, функция отменяет только указанное перенаправление устройства. Если параметр указывает удаленный сетевой ресурс, то отменяются только подключения к удаленным сетям без устройств.

[in] fForce

Указывает, должно ли происходить отключение при наличии открытых файлов или заданий в подключении. Если этот параметр имеет значение FALSE, функция завершается ошибкой при наличии открытых файлов или заданий.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращаемое значение представляет собой системный код ошибки, например одно из следующих значений.

Код возврата	Описание
ERROR_BAD_PROFILE	Профиль пользователя имеет неправильный формат.
ERROR_CANNOT_OPEN_PROFILE	Системе не удается открыть профиль пользователя для обработки постоянных подключений.
ERROR_DEVICE_IN_USE	Устройство используется активным процессом и не может быть отключено.
ERROR_EXTENDED_ERROR	Произошла ошибка, относявшаяся к сети. Чтобы получить описание ошибки, вызовите функцию WNetGetLastError .
ERROR_NOT_CONNECTED	Имя, указанное параметром lpName , не является перенаправленным устройством или система в настоящее время не подключена к устройству, указанному параметром .
ERROR_OPEN_FILES	Существуют открытые файлы, а параметр fForce имеет значение FALSE.

Windows Server 2003 и Windows XP: Функции WNet создают и удаляют буквы сетевых дисков в пространстве имен устройств MS-DOS, связанном с сеансом входа, так как устройства MS-DOS идентифицируются по идентификатору authenticationID. (AuthenticationID — это локальный уникальный идентификатор (LUID), связанный с сеансом входа в систему.) Это может повлиять на приложения, которые вызывают одну из функций WNet для создания буквы сетевого диска при входе одного пользователя, но запрашивают существующие буквы сетевых дисков при входе другого пользователя. Примером такой ситуации может быть создание второго входа пользователя в сеансе входа, например путем вызова функции CreateProcessAsUser , а при втором входе запускается приложение, которое вызывает функцию GetLogicalDrives . GetLogicalDrives не возвращает буквы сетевых дисков, созданные функцией WNet при первом входе в систему. Обратите внимание, что в предыдущем примере первый сеанс входа по-прежнему существует, и этот пример может применяться к любому сеансу входа, включая сеанс служб терминалов. Дополнительные сведения см. в разделе Определение имени устройства MS-DOS.

Примечание

Заголовок winnetwk.h определяет WNetCancelConnection в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winnetwk.h
Библиотека	Mpr.lib
DLL	Mpr.dll