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 パラメーターで指定された名前がリダイレクトされたデバイスではないか、 パラメーターで指定されたデバイスにシステムが現在接続されていません。 |
|
開いているファイルがあり、 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 を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnetwk.h |
| Library | Mpr.lib |
| [DLL] | Mpr.dll |