Win32 API 日本語リファレンス
ホーム › NetworkManagement.WNet › WNetCancelConnectionW

WNetCancelConnectionW

関数
ネットワークリソースへの接続を切断する(Unicode版)。
DLLMPR.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// MPR.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR WNetCancelConnectionW(
    LPCWSTR lpName,
    BOOL fForce
);

パラメーター

名前型方向説明
lpNameLPCWSTRin

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

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

fForceBOOLin接続上に開かれているファイルまたはジョブが存在する場合に切断を行うかどうかを指定します。このパラメーターが FALSE の場合、開かれているファイルまたはジョブがあると関数は失敗します。

戻り値の型: WIN32_ERROR

公式ドキュメント

WNetCancelConnection 関数は、既存のネットワーク接続をキャンセルします。(Unicode)

戻り値

関数が成功した場合、戻り値は 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 です。

解説(Remarks)

Windows Server 2003 および Windows XP: MS-DOS デバイスは AuthenticationID によって識別されるため、WNet 関数はログオンセッションに関連付けられた MS-DOS デバイス名前空間内でネットワークドライブ文字を作成および削除します。(AuthenticationID とは、ログオンセッションに関連付けられた ローカル一意識別子、すなわち LUID です。) このことは、あるユーザーログオンで WNet 関数のいずれかを呼び出してネットワークドライブ文字を作成し、別のユーザーログオンで既存のネットワークドライブ文字を照会するアプリケーションに影響を与える可能性があります。この状況の例としては、たとえば CreateProcessAsUser 関数の呼び出しによって、ログオンセッション内でユーザーの 2 つ目のログオンが作成され、その 2 つ目のログオンで GetLogicalDrives 関数を呼び出すアプリケーションを実行する場合が挙げられます。GetLogicalDrives は、1 つ目のログオンで WNet 関数によって作成されたネットワークドライブ文字を返しません。上記の例では 1 つ目のログオンセッションはまだ存在しており、この例はターミナルサービスセッションを含む任意のログオンセッションに当てはまる点に注意してください。詳細については、 Defining an MS-DOS Device Name を参照してください。

メモ

winnetwk.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WNetCancelConnection を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// MPR.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR WNetCancelConnectionW(
    LPCWSTR lpName,
    BOOL fForce
);
[DllImport("MPR.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint WNetCancelConnectionW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR
    bool fForce   // BOOL
);
<DllImport("MPR.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function WNetCancelConnectionW(
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR
    fForce As Boolean   ' BOOL
) As UInteger
End Function
' lpName : LPCWSTR
' fForce : BOOL
Declare PtrSafe Function WNetCancelConnectionW Lib "mpr" ( _
    ByVal lpName As LongPtr, _
    ByVal fForce As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WNetCancelConnectionW = ctypes.windll.mpr.WNetCancelConnectionW
WNetCancelConnectionW.restype = wintypes.DWORD
WNetCancelConnectionW.argtypes = [
    wintypes.LPCWSTR,  # lpName : LPCWSTR
    wintypes.BOOL,  # fForce : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPR.dll')
WNetCancelConnectionW = Fiddle::Function.new(
  lib['WNetCancelConnectionW'],
  [
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
    Fiddle::TYPE_INT,  # fForce : BOOL
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "mpr")]
extern "system" {
    fn WNetCancelConnectionW(
        lpName: *const u16,  // LPCWSTR
        fForce: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPR.dll", CharSet = CharSet.Unicode)]
public static extern uint WNetCancelConnectionW([MarshalAs(UnmanagedType.LPWStr)] string lpName, bool fForce);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_WNetCancelConnectionW' -Namespace Win32 -PassThru
# $api::WNetCancelConnectionW(lpName, fForce)
#uselib "MPR.dll"
#func global WNetCancelConnectionW "WNetCancelConnectionW" wptr, wptr
; WNetCancelConnectionW lpName, fForce   ; 戻り値は stat
; lpName : LPCWSTR -> "wptr"
; fForce : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "MPR.dll"
#cfunc global WNetCancelConnectionW "WNetCancelConnectionW" wstr, int
; res = WNetCancelConnectionW(lpName, fForce)
; lpName : LPCWSTR -> "wstr"
; fForce : BOOL -> "int"
; WIN32_ERROR WNetCancelConnectionW(LPCWSTR lpName, BOOL fForce)
#uselib "MPR.dll"
#cfunc global WNetCancelConnectionW "WNetCancelConnectionW" wstr, int
; res = WNetCancelConnectionW(lpName, fForce)
; lpName : LPCWSTR -> "wstr"
; fForce : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mpr = windows.NewLazySystemDLL("MPR.dll")
	procWNetCancelConnectionW = mpr.NewProc("WNetCancelConnectionW")
)

// lpName (LPCWSTR), fForce (BOOL)
r1, _, err := procWNetCancelConnectionW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
	uintptr(fForce),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function WNetCancelConnectionW(
  lpName: PWideChar;   // LPCWSTR
  fForce: BOOL   // BOOL
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetCancelConnectionW';
result := DllCall("MPR\WNetCancelConnectionW"
    , "WStr", lpName   ; LPCWSTR
    , "Int", fForce   ; BOOL
    , "UInt")   ; return: WIN32_ERROR
●WNetCancelConnectionW(lpName, fForce) = DLL("MPR.dll", "dword WNetCancelConnectionW(char*, bool)")
# 呼び出し: WNetCancelConnectionW(lpName, fForce)
# lpName : LPCWSTR -> "char*"
# fForce : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "mpr" fn WNetCancelConnectionW(
    lpName: [*c]const u16, // LPCWSTR
    fForce: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WNetCancelConnectionW(
    lpName: WideCString,  # LPCWSTR
    fForce: int32  # BOOL
): uint32 {.importc: "WNetCancelConnectionW", stdcall, dynlib: "MPR.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "mpr");
extern(Windows)
uint WNetCancelConnectionW(
    const(wchar)* lpName,   // LPCWSTR
    int fForce   // BOOL
);
ccall((:WNetCancelConnectionW, "MPR.dll"), stdcall, UInt32,
      (Cwstring, Int32),
      lpName, fForce)
# lpName : LPCWSTR -> Cwstring
# fForce : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WNetCancelConnectionW(
    const uint16_t* lpName,
    int32_t fForce);
]]
local mpr = ffi.load("mpr")
-- mpr.WNetCancelConnectionW(lpName, fForce)
-- lpName : LPCWSTR
-- fForce : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('MPR.dll');
const WNetCancelConnectionW = lib.func('__stdcall', 'WNetCancelConnectionW', 'uint32_t', ['str16', 'int32_t']);
// WNetCancelConnectionW(lpName, fForce)
// lpName : LPCWSTR -> 'str16'
// fForce : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPR.dll", {
  WNetCancelConnectionW: { parameters: ["buffer", "i32"], result: "u32" },
});
// lib.symbols.WNetCancelConnectionW(lpName, fForce)
// lpName : LPCWSTR -> "buffer"
// fForce : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WNetCancelConnectionW(
    const uint16_t* lpName,
    int32_t fForce);
C, "MPR.dll");
// $ffi->WNetCancelConnectionW(lpName, fForce);
// lpName : LPCWSTR
// fForce : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Mpr extends StdCallLibrary {
    Mpr INSTANCE = Native.load("mpr", Mpr.class, W32APIOptions.UNICODE_OPTIONS);
    int WNetCancelConnectionW(
        WString lpName,   // LPCWSTR
        boolean fForce   // BOOL
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("mpr")]
lib LibMPR
  fun WNetCancelConnectionW = WNetCancelConnectionW(
    lpName : UInt16*,   # LPCWSTR
    fForce : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WNetCancelConnectionWNative = Uint32 Function(Pointer<Utf16>, Int32);
typedef WNetCancelConnectionWDart = int Function(Pointer<Utf16>, int);
final WNetCancelConnectionW = DynamicLibrary.open('MPR.dll')
    .lookupFunction<WNetCancelConnectionWNative, WNetCancelConnectionWDart>('WNetCancelConnectionW');
// lpName : LPCWSTR -> Pointer<Utf16>
// fForce : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WNetCancelConnectionW(
  lpName: PWideChar;   // LPCWSTR
  fForce: BOOL   // BOOL
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetCancelConnectionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WNetCancelConnectionW"
  c_WNetCancelConnectionW :: CWString -> CInt -> IO Word32
-- lpName : LPCWSTR -> CWString
-- fForce : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wnetcancelconnectionw =
  foreign "WNetCancelConnectionW"
    ((ptr uint16_t) @-> int32_t @-> returning uint32_t)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* fForce : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mpr (t "MPR.dll"))
(cffi:use-foreign-library mpr)

(cffi:defcfun ("WNetCancelConnectionW" wnet-cancel-connection-w :convention :stdcall) :uint32
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR
  (f-force :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WNetCancelConnectionW = Win32::API::More->new('MPR',
    'DWORD WNetCancelConnectionW(LPCWSTR lpName, BOOL fForce)');
# my $ret = $WNetCancelConnectionW->Call($lpName, $fForce);
# lpName : LPCWSTR -> LPCWSTR
# fForce : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型