ホーム › NetworkManagement.NetManagement › NetUseAdd

NetUseAdd

関数

ネットワーク共有への接続を確立する。

DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// NETAPI32.dll
#include <windows.h>

DWORD NetUseAdd(
    CHAR* servername,   // optional
    DWORD LevelFlags,
    BYTE* buf,
    DWORD* parm_err   // optional
);

パラメーター

名前

型

方向

説明

servername

CHAR*

inoptional

この関数を実行するコンピューターの UNC 名です。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。UncServerName パラメーターにリモートコンピューターを指定する場合、そのリモートコンピューターはレガシーな Remote Access Protocol の仕組みを用いたリモート RPC 呼び出しをサポートしている必要があります。

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode になります。

LevelFlags

DWORD

データの情報レベルを指定する値です。このパラメーターには、次のいずれかの値を指定できます。

値	意味
1	ローカルデバイスと共有リソースの間の接続に関する情報を指定します。情報には、接続の状態と種類が含まれます。Buf パラメーターは USE_INFO_1 構造体へのポインターです。
2	ローカルデバイスと共有リソースの間の接続に関する情報を指定します。情報には、接続の状態と種類、ユーザー名、ドメイン名が含まれます。Buf パラメーターは USE_INFO_2 構造体へのポインターです。

buf

BYTE*

データを指定するバッファーへのポインターです。このデータの形式は Level パラメーターの値によって異なります。詳細については、 Network Management Function Buffers を参照してください。

parm_err

DWORD*

outoptional

ERROR_INVALID_PARAMETER エラーが返されたときに、エラーの原因となった情報構造体の最初のメンバーのインデックスを受け取る値へのポインターです。このパラメーターが NULL の場合、エラー時にインデックスは返されません。詳細については、後述の「解説」セクションを参照してください。

戻り値の型: DWORD

公式ドキュメント

NetUseAdd 関数は、ローカルコンピューターとリモートサーバーの間に接続を確立します。

戻り値

関数が成功した場合、戻り値は NERR_Success です。

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの一覧については、 System Error Codes を参照してください。

解説(Remarks)

ローカルデバイスをネットワークリソースにリダイレクトするには、 WNetAddConnection2 関数や WNetAddConnection3 関数を使用することもできます。

NetUseAdd 関数を呼び出すために特別なグループメンバーシップは必要ありません。この関数は、ダウンレベル互換性の場合を除き、リモートサーバー上で実行することはできません。

この関数は、Server Message Block (LAN Manager Workstation) クライアントにのみ適用されます。NetUseAdd 関数は、分散ファイルシステム (DFS) 共有をサポートしていません。別のネットワークプロバイダー (たとえば WebDAV や DFS 共有) を使用して共有を追加するには、WNetAddConnection2 関数または WNetAddConnection3 関数を使用してください。

NetUseAdd 関数が ERROR_INVALID_PARAMETER を返した場合、ParmError パラメーターを使用して、無効となった情報構造体の最初のメンバーを特定できます。(情報構造体は USE_INFO_ で始まり、その形式は Level パラメーターによって指定されます。) 次の表は、ParmError パラメーターに返される可能性のある値と、それに対応するエラーの原因となる構造体メンバーを示しています。(接頭辞 ui*_ は、そのメンバーが複数の接頭辞 (たとえば ui1_ や ui2_) で始まる可能性があることを示します。)

定数	値	メンバー
USE_LOCAL_PARMNUM	1	ui*_local
USE_REMOTE_PARMNUM	2	ui*_remote
USE_PASSWORD_PARMNUM	3	ui*_password
USE_ASGTYPE_PARMNUM	4	ui*_asg_type
USE_USERNAME_PARMNUM	5	ui*_username
USE_DOMAINNAME_PARMNUM	6	ui*_domainname

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

各言語での呼び出し定義

// NETAPI32.dll
#include <windows.h>

DWORD NetUseAdd(
    CHAR* servername,   // optional
    DWORD LevelFlags,
    BYTE* buf,
    DWORD* parm_err   // optional
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetUseAdd(
    IntPtr servername,   // CHAR* optional
    uint LevelFlags,   // DWORD
    IntPtr buf,   // BYTE*
    IntPtr parm_err   // DWORD* optional, out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetUseAdd(
    servername As IntPtr,   ' CHAR* optional
    LevelFlags As UInteger,   ' DWORD
    buf As IntPtr,   ' BYTE*
    parm_err As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

' servername : CHAR* optional
' LevelFlags : DWORD
' buf : BYTE*
' parm_err : DWORD* optional, out
Declare PtrSafe Function NetUseAdd Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal LevelFlags As Long, _
    ByVal buf As LongPtr, _
    ByVal parm_err As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetUseAdd = ctypes.windll.netapi32.NetUseAdd
NetUseAdd.restype = wintypes.DWORD
NetUseAdd.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # servername : CHAR* optional
    wintypes.DWORD,  # LevelFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # buf : BYTE*
    ctypes.POINTER(wintypes.DWORD),  # parm_err : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetUseAdd = Fiddle::Function.new(
  lib['NetUseAdd'],
  [
    Fiddle::TYPE_VOIDP,  # servername : CHAR* optional
    -Fiddle::TYPE_INT,  # LevelFlags : DWORD
    Fiddle::TYPE_VOIDP,  # buf : BYTE*
    Fiddle::TYPE_VOIDP,  # parm_err : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetUseAdd(
        servername: *mut i8,  // CHAR* optional
        LevelFlags: u32,  // DWORD
        buf: *mut u8,  // BYTE*
        parm_err: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetUseAdd(IntPtr servername, uint LevelFlags, IntPtr buf, IntPtr parm_err);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetUseAdd' -Namespace Win32 -PassThru
# $api::NetUseAdd(servername, LevelFlags, buf, parm_err)

#uselib "NETAPI32.dll"
#func global NetUseAdd "NetUseAdd" sptr, sptr, sptr, sptr
; NetUseAdd varptr(servername), LevelFlags, varptr(buf), varptr(parm_err)   ; 戻り値は stat
; servername : CHAR* optional -> "sptr"
; LevelFlags : DWORD -> "sptr"
; buf : BYTE* -> "sptr"
; parm_err : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NETAPI32.dll"
#cfunc global NetUseAdd "NetUseAdd" var, int, var, var
; res = NetUseAdd(servername, LevelFlags, buf, parm_err)
; servername : CHAR* optional -> "var"
; LevelFlags : DWORD -> "int"
; buf : BYTE* -> "var"
; parm_err : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetUseAdd "NetUseAdd" sptr, int, sptr, sptr
; res = NetUseAdd(varptr(servername), LevelFlags, varptr(buf), varptr(parm_err))
; servername : CHAR* optional -> "sptr"
; LevelFlags : DWORD -> "int"
; buf : BYTE* -> "sptr"
; parm_err : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。