WNetCancelConnection2A
関数シグネチャ
// MPR.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR WNetCancelConnection2A(
LPCSTR lpName,
NET_CONNECT_FLAGS dwFlags,
BOOL fForce
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| lpName | LPCSTR | in | 切断対象となる、リダイレクトされたローカルデバイスまたはリモートネットワークリソースの名前を指定する、定数の null 終端文字列へのポインター。 このパラメーターがリダイレクトされたローカルデバイスを指定している場合、関数は指定されたデバイスのリダイレクトのみをキャンセルします。パラメーターがリモートネットワークリソースを指定している場合、デバイスを伴わないすべての接続がキャンセルされます。 | ||||||
| dwFlags | NET_CONNECT_FLAGS | in | 接続の種類。次の値が定義されています。
| ||||||
| fForce | BOOL | in | 接続上に開いているファイルまたはジョブがある場合に切断を行うかどうかを指定します。このパラメーターが FALSE の場合、開いているファイルまたはジョブがあると関数は失敗します。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
WNetCancelConnection2 関数は、既存のネットワーク接続をキャンセルします。現在接続されていない、記憶されたネットワーク接続を削除する目的でこの関数を呼び出すこともできます。(ANSI)
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は システムエラーコード であり、次のいずれかの値になります。
| 戻り値 | 説明 |
|---|---|
| ユーザープロファイルの形式が正しくありません。 | |
| システムは、永続的な接続を処理するためのユーザープロファイルを開くことができません。 | |
| デバイスはアクティブなプロセスによって使用中であり、切断できません。 | |
| ネットワーク固有のエラーが発生しました。エラーの説明を取得するには、 WNetGetLastError 関数を呼び出します。 | |
| lpName パラメーターで指定された名前がリダイレクトされたデバイスではないか、システムが現在そのパラメーターで指定されたデバイスに接続されていません。 | |
| 開いているファイルがあり、かつ fForce パラメーターが FALSE です。 |
解説(Remarks)
Windows Server 2003 および Windows XP: MS-DOS デバイスは AuthenticationID によって識別されるため、WNet 関数はログオンセッションに関連付けられた MS-DOS デバイス名前空間内でネットワークドライブ文字を作成および削除します。(AuthenticationID とは、ログオンセッションに関連付けられた ローカル一意識別子 (locally unique identifier)、すなわち LUID です。) このことは、あるユーザーのログオンでいずれかの WNet 関数を呼び出してネットワークドライブ文字を作成し、別のユーザーのログオンで既存のネットワークドライブ文字を照会するアプリケーションに影響する可能性があります。この状況の例としては、たとえば CreateProcessAsUser 関数の呼び出しによって、あるログオンセッション内でユーザーの 2 番目のログオンが作成され、その 2 番目のログオンで GetLogicalDrives 関数を呼び出すアプリケーションが実行される場合が挙げられます。GetLogicalDrives は、最初のログオンで WNet 関数によって作成されたネットワークドライブ文字を返しません。なお、上記の例では最初のログオンセッションはまだ存在しており、この例はターミナルサービスセッションを含む任意のログオンセッションに当てはまる可能性があります。詳細については、 Defining an MS-DOS Device Name を参照してください。
例
WNetCancelConnection2 関数の呼び出しによってネットワークリソースへの接続をキャンセルする方法を示すコードサンプルについては、 Canceling a Network Connection を参照してください。
winnetwk.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WNetCancelConnection2 を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// MPR.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR WNetCancelConnection2A(
LPCSTR lpName,
NET_CONNECT_FLAGS dwFlags,
BOOL fForce
);[DllImport("MPR.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint WNetCancelConnection2A(
[MarshalAs(UnmanagedType.LPStr)] string lpName, // LPCSTR
uint dwFlags, // NET_CONNECT_FLAGS
bool fForce // BOOL
);<DllImport("MPR.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function WNetCancelConnection2A(
<MarshalAs(UnmanagedType.LPStr)> lpName As String, ' LPCSTR
dwFlags As UInteger, ' NET_CONNECT_FLAGS
fForce As Boolean ' BOOL
) As UInteger
End Function' lpName : LPCSTR
' dwFlags : NET_CONNECT_FLAGS
' fForce : BOOL
Declare PtrSafe Function WNetCancelConnection2A Lib "mpr" ( _
ByVal lpName As String, _
ByVal dwFlags As Long, _
ByVal fForce As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WNetCancelConnection2A = ctypes.windll.mpr.WNetCancelConnection2A
WNetCancelConnection2A.restype = wintypes.DWORD
WNetCancelConnection2A.argtypes = [
wintypes.LPCSTR, # lpName : LPCSTR
wintypes.DWORD, # dwFlags : NET_CONNECT_FLAGS
wintypes.BOOL, # fForce : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('MPR.dll')
WNetCancelConnection2A = Fiddle::Function.new(
lib['WNetCancelConnection2A'],
[
Fiddle::TYPE_VOIDP, # lpName : LPCSTR
-Fiddle::TYPE_INT, # dwFlags : NET_CONNECT_FLAGS
Fiddle::TYPE_INT, # fForce : BOOL
],
-Fiddle::TYPE_INT)#[link(name = "mpr")]
extern "system" {
fn WNetCancelConnection2A(
lpName: *const u8, // LPCSTR
dwFlags: u32, // NET_CONNECT_FLAGS
fForce: i32 // BOOL
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("MPR.dll", CharSet = CharSet.Ansi)]
public static extern uint WNetCancelConnection2A([MarshalAs(UnmanagedType.LPStr)] string lpName, uint dwFlags, bool fForce);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_WNetCancelConnection2A' -Namespace Win32 -PassThru
# $api::WNetCancelConnection2A(lpName, dwFlags, fForce)#uselib "MPR.dll"
#func global WNetCancelConnection2A "WNetCancelConnection2A" sptr, sptr, sptr
; WNetCancelConnection2A lpName, dwFlags, fForce ; 戻り値は stat
; lpName : LPCSTR -> "sptr"
; dwFlags : NET_CONNECT_FLAGS -> "sptr"
; fForce : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "MPR.dll"
#cfunc global WNetCancelConnection2A "WNetCancelConnection2A" str, int, int
; res = WNetCancelConnection2A(lpName, dwFlags, fForce)
; lpName : LPCSTR -> "str"
; dwFlags : NET_CONNECT_FLAGS -> "int"
; fForce : BOOL -> "int"; WIN32_ERROR WNetCancelConnection2A(LPCSTR lpName, NET_CONNECT_FLAGS dwFlags, BOOL fForce)
#uselib "MPR.dll"
#cfunc global WNetCancelConnection2A "WNetCancelConnection2A" str, int, int
; res = WNetCancelConnection2A(lpName, dwFlags, fForce)
; lpName : LPCSTR -> "str"
; dwFlags : NET_CONNECT_FLAGS -> "int"
; fForce : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
mpr = windows.NewLazySystemDLL("MPR.dll")
procWNetCancelConnection2A = mpr.NewProc("WNetCancelConnection2A")
)
// lpName (LPCSTR), dwFlags (NET_CONNECT_FLAGS), fForce (BOOL)
r1, _, err := procWNetCancelConnection2A.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpName))),
uintptr(dwFlags),
uintptr(fForce),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction WNetCancelConnection2A(
lpName: PAnsiChar; // LPCSTR
dwFlags: DWORD; // NET_CONNECT_FLAGS
fForce: BOOL // BOOL
): DWORD; stdcall;
external 'MPR.dll' name 'WNetCancelConnection2A';result := DllCall("MPR\WNetCancelConnection2A"
, "AStr", lpName ; LPCSTR
, "UInt", dwFlags ; NET_CONNECT_FLAGS
, "Int", fForce ; BOOL
, "UInt") ; return: WIN32_ERROR●WNetCancelConnection2A(lpName, dwFlags, fForce) = DLL("MPR.dll", "dword WNetCancelConnection2A(char*, dword, bool)")
# 呼び出し: WNetCancelConnection2A(lpName, dwFlags, fForce)
# lpName : LPCSTR -> "char*"
# dwFlags : NET_CONNECT_FLAGS -> "dword"
# fForce : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "mpr" fn WNetCancelConnection2A(
lpName: [*c]const u8, // LPCSTR
dwFlags: u32, // NET_CONNECT_FLAGS
fForce: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;proc WNetCancelConnection2A(
lpName: cstring, # LPCSTR
dwFlags: uint32, # NET_CONNECT_FLAGS
fForce: int32 # BOOL
): uint32 {.importc: "WNetCancelConnection2A", stdcall, dynlib: "MPR.dll".}pragma(lib, "mpr");
extern(Windows)
uint WNetCancelConnection2A(
const(char)* lpName, // LPCSTR
uint dwFlags, // NET_CONNECT_FLAGS
int fForce // BOOL
);ccall((:WNetCancelConnection2A, "MPR.dll"), stdcall, UInt32,
(Cstring, UInt32, Int32),
lpName, dwFlags, fForce)
# lpName : LPCSTR -> Cstring
# dwFlags : NET_CONNECT_FLAGS -> UInt32
# fForce : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t WNetCancelConnection2A(
const char* lpName,
uint32_t dwFlags,
int32_t fForce);
]]
local mpr = ffi.load("mpr")
-- mpr.WNetCancelConnection2A(lpName, dwFlags, fForce)
-- lpName : LPCSTR
-- dwFlags : NET_CONNECT_FLAGS
-- fForce : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('MPR.dll');
const WNetCancelConnection2A = lib.func('__stdcall', 'WNetCancelConnection2A', 'uint32_t', ['str', 'uint32_t', 'int32_t']);
// WNetCancelConnection2A(lpName, dwFlags, fForce)
// lpName : LPCSTR -> 'str'
// dwFlags : NET_CONNECT_FLAGS -> 'uint32_t'
// fForce : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("MPR.dll", {
WNetCancelConnection2A: { parameters: ["buffer", "u32", "i32"], result: "u32" },
});
// lib.symbols.WNetCancelConnection2A(lpName, dwFlags, fForce)
// lpName : LPCSTR -> "buffer"
// dwFlags : NET_CONNECT_FLAGS -> "u32"
// fForce : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t WNetCancelConnection2A(
const char* lpName,
uint32_t dwFlags,
int32_t fForce);
C, "MPR.dll");
// $ffi->WNetCancelConnection2A(lpName, dwFlags, fForce);
// lpName : LPCSTR
// dwFlags : NET_CONNECT_FLAGS
// 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.ASCII_OPTIONS);
int WNetCancelConnection2A(
String lpName, // LPCSTR
int dwFlags, // NET_CONNECT_FLAGS
boolean fForce // BOOL
);
}@[Link("mpr")]
lib LibMPR
fun WNetCancelConnection2A = WNetCancelConnection2A(
lpName : UInt8*, # LPCSTR
dwFlags : UInt32, # NET_CONNECT_FLAGS
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 WNetCancelConnection2ANative = Uint32 Function(Pointer<Utf8>, Uint32, Int32);
typedef WNetCancelConnection2ADart = int Function(Pointer<Utf8>, int, int);
final WNetCancelConnection2A = DynamicLibrary.open('MPR.dll')
.lookupFunction<WNetCancelConnection2ANative, WNetCancelConnection2ADart>('WNetCancelConnection2A');
// lpName : LPCSTR -> Pointer<Utf8>
// dwFlags : NET_CONNECT_FLAGS -> Uint32
// fForce : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WNetCancelConnection2A(
lpName: PAnsiChar; // LPCSTR
dwFlags: DWORD; // NET_CONNECT_FLAGS
fForce: BOOL // BOOL
): DWORD; stdcall;
external 'MPR.dll' name 'WNetCancelConnection2A';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WNetCancelConnection2A"
c_WNetCancelConnection2A :: CString -> Word32 -> CInt -> IO Word32
-- lpName : LPCSTR -> CString
-- dwFlags : NET_CONNECT_FLAGS -> Word32
-- fForce : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wnetcancelconnection2a =
foreign "WNetCancelConnection2A"
(string @-> uint32_t @-> int32_t @-> returning uint32_t)
(* lpName : LPCSTR -> string *)
(* dwFlags : NET_CONNECT_FLAGS -> uint32_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 ("WNetCancelConnection2A" wnet-cancel-connection2-a :convention :stdcall) :uint32
(lp-name :string) ; LPCSTR
(dw-flags :uint32) ; NET_CONNECT_FLAGS
(f-force :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WNetCancelConnection2A = Win32::API::More->new('MPR',
'DWORD WNetCancelConnection2A(LPCSTR lpName, DWORD dwFlags, BOOL fForce)');
# my $ret = $WNetCancelConnection2A->Call($lpName, $dwFlags, $fForce);
# lpName : LPCSTR -> LPCSTR
# dwFlags : NET_CONNECT_FLAGS -> DWORD
# fForce : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WNetCancelConnection2W (Unicode版) — フラグを指定してネットワーク接続を切断する(Unicode版)。
- f WNetCancelConnectionA — ネットワークリソースへの接続を切断する(ANSI版)。
- f WNetAddConnection2A — 資格情報を指定してネットワークリソースに接続する(ANSI版)。
- f WNetAddConnection3A — 所有ウィンドウを指定してネットワークリソースに接続する(ANSI版)。
- f WNetGetConnectionA — ローカル名に対応するリモートネットワーク名を取得する(ANSI版)。