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

Статья
08/27/2023

Функция WNetCancelConnection2 отменяет существующее сетевое подключение. Можно также вызвать функцию , чтобы удалить сохраненные сетевые подключения, которые в настоящее время не подключены.

Функция WNetCancelConnection2 заменяет функцию WNetCancelConnection .

Синтаксис

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

Параметры

[in] lpName

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

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

[in] dwFlags

Тип подключения. Определены следующие значения.

Значение	Значение
0	Система не обновляет сведения о подключении. Если подключение было отмечено в реестре как постоянное, система продолжит восстановление подключения при следующем входе в систему. Если подключение не было отмечено как постоянное, функция игнорирует параметр флага CONNECT_UPDATE_PROFILE.
CONNECT_UPDATE_PROFILE	Система обновляет профиль пользователя, используя сведения о том, что подключение больше не является постоянным. Система не восстановит это подключение во время последующих операций входа. (Отключение ресурсов с помощью удаленных имен не влияет на постоянные подключения.)

Значение

0

Система не обновляет сведения о подключении.

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

CONNECT_UPDATE_PROFILE

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

Система не восстановит это подключение во время последующих операций входа. (Отключение ресурсов с помощью удаленных имен не влияет на постоянные подключения.)

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

Примеры

Пример кода, иллюстрирующий отмену подключения к сетевому ресурсу с помощью вызова функции WNetCancelConnection2 , см. в разделе Отмена сетевого подключения.

Примечание

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

Требования


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