WNetCancelConnectionA 関数 (winnetwk.h)

[アーティクル]
03/04/2024

WNetCancelConnection 関数は、既存のネットワーク接続を取り消します。

WNetCancelConnection 関数は、16 ビットバージョンの Windows との互換性のために提供されます。他の Windows ベースのアプリケーションでは、WNetCancelConnection2 関数を呼び出す必要があります。

構文

DWORD WNetCancelConnectionA(
  [in] LPCSTR lpName,
  [in] BOOL   fForce
);

パラメーター

[in] lpName

リダイレクトされたローカルデバイスまたは切断するリモートネットワークリソースの名前を指定する、null で終わる定数文字列へのポインター。

このパラメーターでリダイレクトされたローカルデバイスを指定すると、関数は指定されたデバイスリダイレクトのみを取り消します。パラメーターでリモートネットワークリソースが指定されている場合、デバイスのないリモートネットワークへの接続のみが取り消されます。

[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 デバイス名の定義」を参照してください。

注意

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

要件

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