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