WNetCancelConnection2A 関数 (winnetwk.h)
WNetCancelConnection2 関数は、既存のネットワーク接続を取り消します。 関数を呼び出して、現在接続されていない記憶されたネットワーク接続を削除することもできます。
WNetCancelConnection2 関数は、WNetCancelConnection 関数よりも優先されます。
構文
DWORD WNetCancelConnection2A(
[in] LPCSTR lpName,
[in] DWORD dwFlags,
[in] BOOL fForce
);
パラメーター
[in] lpName
リダイレクトされたローカル デバイスまたは切断するリモート ネットワーク リソースの名前を指定する null終了文字列
このパラメーターでリダイレクトされたローカル デバイスを指定した場合、関数は指定されたデバイス リダイレクトのみを取り消します。 このパラメーターでリモート ネットワーク リソースが指定されている場合、デバイスのない接続はすべて取り消されます。
[in] dwFlags
接続の種類。 次の値が定義されています。
[in] fForce
接続に開いているファイルまたはジョブがある場合に切断を行うかどうかを指定します。 このパラメーターが FALSE
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は システム エラー コード(次のいずれかの値など) です。
リターン コード | 形容 |
---|---|
|
ユーザー プロファイルの形式が正しくありません。 |
|
システムは、永続的な接続を処理するためにユーザー プロファイルを開くことができません。 |
|
デバイスはアクティブなプロセスによって使用されており、切断できません。 |
|
ネットワーク固有のエラーが発生しました。 エラーの説明を取得するには、WNetGetLastError 関数を呼び出します。 |
|
lpName パラメーターで指定された名前がリダイレクトされたデバイスではないか、システムが現在、パラメーターで指定されたデバイスに接続されていません。 |
|
開いているファイルがあり、 |
備考
Windows Server 2003 および Windows XP: WNet 関数は、MS-DOS デバイスが AuthenticationID によって識別されるため、ログオン セッションに関連付けられている MS-DOS デバイス名前空間でネットワーク ドライブ文字を作成および削除します。 (AuthenticationID は、ログオン セッションに関連付けられた ローカル一意識別子 (LUID)です)。これは、いずれかの WNet 関数を呼び出して 1 人のユーザー ログオンでネットワーク ドライブ文字を作成するが、別のユーザー ログオンで既存のネットワーク ドライブ文字を照会するアプリケーションに影響を与える可能性があります。 このような状況の例としては、たとえば、CreateProcessAsUser 関数を呼び出すことによって、ログオン セッション内にユーザーの 2 番目のログオンが作成され、2 番目のログオンで、GetLogicalDrives 関数を呼び出すアプリケーションが実行される場合があります。
GetLogicalDrives は、最初のログオン時に WNet 関数によって作成されたネットワーク ドライブ文字を返しません。 前の例では、最初のログオン セッションがまだ存在し、ターミナル サービス セッションを含む任意のログオン セッションにこの例を適用できることに注意してください。 詳細については、「MS-DOS デバイス名の定義
例
WNetCancelConnection2 関数の呼び出しでネットワーク リソースへの接続を取り消す方法を示すコード サンプルについては、「ネットワーク接続のキャンセル」を参照してください。
手記
winnetwk.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WNetCancelConnection2 を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされる最小サーバー | Windows 2000 Server [デスクトップ アプリのみ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | winnetwk.h |
ライブラリ | Mpr.lib |
DLL | Mpr.dll |
関連項目
WNetAddConnection2 の
WNetAddConnection3 の
WNetGetConnection の