WNetCancelConnection2W 関数 (winnetwk.h)

[アーティクル]
08/27/2023

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	システムは、接続が永続的ではないという情報を使用してユーザープロファイルを更新します。システムは、後続のログオン操作中にこの接続を復元しません。 (リモート名を使用してリソースを切断しても、永続的な接続には影響しません)。

[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 関数のいずれかを呼び出して 1 人のユーザーログオンでネットワークドライブ文字を作成するアプリケーションに影響を与える可能性がありますが、別のユーザーログオンで既存のネットワークドライブ文字を照会します。このような状況の例としては、たとえば CreateProcessAsUser 関数を呼び出してユーザーの 2 番目のログオンがログオンセッション内に作成され、2 番目のログオンで GetLogicalDrives 関数を呼び出すアプリケーションが実行される場合があります。 GetLogicalDrives は、最初の ログオン時に WNet 関数によって作成されたネットワークドライブ文字を返しません。前の例では、最初のログオンセッションがまだ存在し、ターミナルサービスセッションを含む任意のログオンセッションに適用できることに注意してください。詳細については、「 MS-DOS デバイス名の定義」を参照してください。

例

WNetCancelConnection2 関数の呼び出しでネットワークリソースへの接続を取り消す方法を示すコードサンプルについては、「ネットワーク接続のキャンセル」を参照してください。

注意

winnetwk.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WNetCancelConnection2 を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイルエラーまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winnetwk.h
Library	Mpr.lib
[DLL]	Mpr.dll