WNetCancelConnection2A 函式 (winnetwk.h)
WNetCancelConnection2 函式會取消現有的網路連線。 您也可以呼叫 函式來移除目前未連線的記住網路連線。
WNetCancelConnection2 函式會取代 WNetCancelConnection 函式。
語法
DWORD WNetCancelConnection2A(
[in] LPCSTR lpName,
[in] DWORD dwFlags,
[in] BOOL fForce
);
參數
[in] lpName
常數的指標 null-terminated 字串,指定要中斷連線的重新導向本機裝置或遠端網路資源的名稱。
如果此參數指定重新導向的本機裝置,函式只會取消指定的裝置重新導向。 如果 參數指定遠端網路資源,則會取消所有沒有裝置的連線。
[in] dwFlags
線上類型。 定義下列值。
價值 | 意義 |
---|---|
|
系統不會更新連線的相關信息。
如果連線在登錄中標示為持續性,系統會在下一次登入時繼續還原連線。 如果連線未標示為持續性,函式會忽略CONNECT_UPDATE_PROFILE旗標的設定。 |
|
系統會使用連線不再是持續性資訊來更新使用者配置檔。
系統不會在後續的登入作業期間還原此連線。 (使用遠端名稱中斷資源連線不會影響持續性連線。 |
[in] fForce
指定如果連接上有開啟的檔案或作業,是否應該發生中斷連線。 如果此參數 FALSE,則當有開啟的檔案或作業時,函式會失敗。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值是 系統錯誤碼,例如下列其中一個值。
傳回碼 | 描述 |
---|---|
|
使用者配置檔的格式不正確。 |
|
系統無法開啟使用者配置檔來處理持續性連線。 |
|
裝置正由使用中進程使用,且無法中斷連線。 |
|
發生網路特定錯誤。 若要取得錯誤的描述,請呼叫 WNetGetLastError 函式。 |
|
lpName 參數所指定的名稱不是重新導向的裝置,或系統目前未連線到 參數所指定的裝置。 |
|
有開啟的檔案,fForce 參數 FALSE。 |
言論
Windows Server 2003 和 Windows XP:WNet 函式會在與登入會話相關聯的 MS-DOS 裝置命名空間中建立和刪除網路驅動器號,因為 authenticationID 會識別 MS-DOS 裝置。 (AuthenticationID 是與登入會話相關聯的本機唯一標識符或 LUID
例子
如需示範如何使用呼叫 WNetCancelConnection2 函式來取消與網路資源的連線的程式代碼範例,請參閱 取消網路連線。
注意
winnetwk.h 標頭會根據 UNICODE 預處理器常數的定義,將 WNetCancelConnection2 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
支援的最低伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | winnetwk.h |
連結庫 | Mpr.lib |
DLL | Mpr.dll |