WNetCancelConnection2A 函式 (winnetwk.h)

發行項
03/08/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	系統會使用連線不再是持續性資訊來更新使用者設定檔。系統不會在後續登入作業期間還原此連線。 (使用遠端名稱中斷資源連線不會影響持續性連線。)

[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 是與登入會話相關聯的本機唯一識別碼或 LUID。) 這可能會影響呼叫其中一個 WNet 函式的應用程式，以在一個使用者登入下建立網路磁碟機號，但在不同的使用者登入下查詢現有的網路磁碟機號。這種情況的範例可能是當使用者的第二次登入是在登入會話內建立時，例如呼叫 CreateProcessAsUser 函式，而第二次登入會執行呼叫 GetLogicalDrives 函式的應用程式。 GetLogicalDrives 不會傳回第一次登入下 WNet 函式所建立的網路磁碟機號。請注意，在上述範例中，第一個登入會話仍然存在，而且此範例可以套用至任何登入會話，包括終端機服務會話。如需詳細資訊，請參閱定義 MS-DOS 裝置名稱。

範例

如需說明如何使用 WNetCancelConnection2 函式呼叫取消網路資源的連線的程式碼範例，請參閱取消網路連線。

注意

winnetwk.h 標頭會將 WNetCancelConnection2 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求


最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	winnetwk.h
程式庫	Mpr.lib
Dll	Mpr.dll