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

Статья
11/20/2024

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

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

Синтаксис

DWORD WNetCancelConnection2W(
  [in] LPCWSTR 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	Существуют открытые файлы, а параметр f Force false.

Замечания

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

Примеры

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winnetwk.h
библиотеки	Mpr.lib
DLL	Mpr.dll