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

NetServerTransportAddEx

関数
拡張情報を指定してサーバーをトランスポートにバインドする。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetServerTransportAddEx(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE* bufptr
);

パラメーター

名前方向説明
servernameLPWSTRinoptional関数を実行するリモート サーバーの名前を指定する文字列へのポインターです。このパラメーターが NULL の場合、ローカル コンピューターが使用されます。
levelDWORDin

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

Value Meaning
0
トランスポート プロトコルに関する情報(名前、アドレス、ネットワーク上の場所など)を指定します。bufptr パラメーターは SERVER_TRANSPORT_INFO_0 構造体を指します。
1
トランスポート プロトコルに関する情報(名前、アドレス、ネットワーク上の場所、ドメインなど)を指定します。bufptr パラメーターは SERVER_TRANSPORT_INFO_1 構造体を指します。
2
レベル 1 と同じ情報に加えて、svti2_flags メンバーを指定します。bufptr パラメーターは SERVER_TRANSPORT_INFO_2 構造体を指します。
3
レベル 2 と同じ情報に加えて、資格情報を指定します。bufptr パラメーターは SERVER_TRANSPORT_INFO_3 構造体を指します。
bufptrBYTE*in

データを格納するバッファーへのポインターです。このデータの形式は level パラメーターの値によって異なります。

詳細については、 Network Management Function Buffers を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetServerTransportAddEx 関数は、指定したサーバーをトランスポート プロトコルにバインドします。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

Return code Description
ERROR_ACCESS_DENIED
ユーザーは要求された情報にアクセスする権限がありません。
ERROR_DUP_NAME
ネットワーク上に重複した名前が存在します。
ERROR_INVALID_DOMAINNAME
ネットワーク上でドメイン名が見つかりませんでした。
ERROR_INVALID_LEVEL
level パラメーターに指定された値が無効です。
ERROR_INVALID_PARAMETER
パラメーターが無効です。

このエラーは、bufptr パラメーターが指す SERVER_TRANSPORT_INFO_0SERVER_TRANSPORT_INFO_1SERVER_TRANSPORT_INFO_2、または SERVER_TRANSPORT_INFO_3 構造体のトランスポート名またはトランスポート アドレスのメンバーが NULL の場合に返されます。また、bufptr パラメーターが指す SERVER_TRANSPORT_INFO_0SERVER_TRANSPORT_INFO_1SERVER_TRANSPORT_INFO_2、または SERVER_TRANSPORT_INFO_3 構造体のトランスポート アドレス長のメンバーが 0 であるか、MAX_PATH(Windef.h ヘッダー ファイルで定義)より大きい場合にも返されます。さらに、bufptr パラメーターが指す SERVER_TRANSPORT_INFO_2 または SERVER_TRANSPORT_INFO_3 構造体のフラグ メンバーに不正な値が含まれている場合にも返されます。

このエラーは、その他の無効なパラメーターに対しても返されます。

ERROR_NOT_ENOUGH_MEMORY
利用可能なメモリが不足しています。

解説(Remarks)

NetServerTransportAddEx 関数を正常に実行できるのは、Administrators または Server Operators ローカル グループのメンバーのみです。

NetServerTransportAddEx 関数の呼び出しによってサーバーにトランスポート プロトコルを追加した場合、その接続はサーバーの再起動後には保持されません。

NetServerComputerNameAdd 関数はユーティリティ関数です。これは NetServerTransportEnum 関数と NetServerTransportAddEx 関数の機能を組み合わせたもので、エミュレートされたサーバー名を指定できます。

Windows Server 2008 および Windows Vista with Service Pack 1 (SP1) では、Windows リモート ファイル サーバー (SRV) に登録されるすべての名前が、スコープ名または非スコープ名のいずれかとして指定されます。システムに追加される各共有は、すべての非スコープ名に対して関連付けられるか、または単一のスコープ名に対して関連付けられます。スコープ機能を使用するアプリケーションは、新しい名前をスコープ エンドポイントとして登録し、適切なスコープで共有を作成する責任の両方を負います。このように、Network Management 関数および Network Share Management 関数の従来の用途は、引き続き共有および名前を非スコープ名として登録するため、まったく影響を受けません。

スコープ エンドポイントは、level パラメーターを 2 に設定し、bufptr パラメーターを svti2_flags メンバーに SVTI2_SCOPED_NAME ビット値を設定した SERVER_TRANSPORT_INFO_2 構造体を指すようにして NetServerTransportAddEx 関数を呼び出すことで作成されます。また、level パラメーターを 3 に設定し、bufptr パラメーターを svti3_flags メンバーに SVTI2_SCOPED_NAME ビット値を設定した SERVER_TRANSPORT_INFO_3 構造体を指すようにして NetServerTransportAddEx 関数を呼び出すことでも作成されます。

トランスポートに対して SVTI2_SCOPED_NAME ビット値が設定されている場合、NetShareAdd 関数を使用して、対応するサーバー名(SHARE_INFO_503 構造体の shi503_servername メンバー)を指定し、スコープ方式で共有を追加できます。SVTI2_SCOPED_NAME ビット値および shi503_servername メンバーで指定された名前で登録されたトランスポートが存在しない場合、スコープ方式での共有の追加は成功しません。

NetShareAdd 関数は、servername パラメーターで指定されたリモート サーバー上にスコープ共有を追加するために使用されます。bufptr パラメーターで渡される SHARE_INFO_503shi503_servername メンバーで指定されたリモート サーバーは、NetServerTransportAddEx 関数によってスコープ エンドポイントとしてトランスポート プロトコルにバインドされている必要があります。SVTI2_SCOPED_NAME フラグは、トランスポート プロトコルの SERVER_TRANSPORT_INFO_2 または SERVER_TRANSPORT_INFO_3 構造体の shi503_servername メンバーに指定されている必要があります。NetShareDelEx 関数はスコープ共有を削除するために使用されます。NetShareGetInfo 関数および NetShareSetInfo 関数は、スコープ共有の情報を取得および設定するために使用されます。

スコープ エンドポイントは、一般的にクラスター名前空間によって使用されます。

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

各言語での呼び出し定義

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

DWORD NetServerTransportAddEx(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE* bufptr
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetServerTransportAddEx(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    uint level,   // DWORD
    IntPtr bufptr   // BYTE*
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetServerTransportAddEx(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    level As UInteger,   ' DWORD
    bufptr As IntPtr   ' BYTE*
) As UInteger
End Function
' servername : LPWSTR optional
' level : DWORD
' bufptr : BYTE*
Declare PtrSafe Function NetServerTransportAddEx Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal level As Long, _
    ByVal bufptr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetServerTransportAddEx = ctypes.windll.netapi32.NetServerTransportAddEx
NetServerTransportAddEx.restype = wintypes.DWORD
NetServerTransportAddEx.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # bufptr : BYTE*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetServerTransportAddEx = Fiddle::Function.new(
  lib['NetServerTransportAddEx'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetServerTransportAddEx(
        servername: *mut u16,  // LPWSTR optional
        level: u32,  // DWORD
        bufptr: *mut u8  // BYTE*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetServerTransportAddEx([MarshalAs(UnmanagedType.LPWStr)] string servername, uint level, IntPtr bufptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetServerTransportAddEx' -Namespace Win32 -PassThru
# $api::NetServerTransportAddEx(servername, level, bufptr)
#uselib "NETAPI32.dll"
#func global NetServerTransportAddEx "NetServerTransportAddEx" sptr, sptr, sptr
; NetServerTransportAddEx servername, level, varptr(bufptr)   ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; level : DWORD -> "sptr"
; bufptr : BYTE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global NetServerTransportAddEx "NetServerTransportAddEx" wstr, int, var
; res = NetServerTransportAddEx(servername, level, bufptr)
; servername : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD NetServerTransportAddEx(LPWSTR servername, DWORD level, BYTE* bufptr)
#uselib "NETAPI32.dll"
#cfunc global NetServerTransportAddEx "NetServerTransportAddEx" wstr, int, var
; res = NetServerTransportAddEx(servername, level, bufptr)
; servername : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetServerTransportAddEx = netapi32.NewProc("NetServerTransportAddEx")
)

// servername (LPWSTR optional), level (DWORD), bufptr (BYTE*)
r1, _, err := procNetServerTransportAddEx.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
	uintptr(level),
	uintptr(bufptr),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetServerTransportAddEx(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer   // BYTE*
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetServerTransportAddEx';
result := DllCall("NETAPI32\NetServerTransportAddEx"
    , "WStr", servername   ; LPWSTR optional
    , "UInt", level   ; DWORD
    , "Ptr", bufptr   ; BYTE*
    , "UInt")   ; return: DWORD
●NetServerTransportAddEx(servername, level, bufptr) = DLL("NETAPI32.dll", "dword NetServerTransportAddEx(char*, dword, void*)")
# 呼び出し: NetServerTransportAddEx(servername, level, bufptr)
# servername : LPWSTR optional -> "char*"
# level : DWORD -> "dword"
# bufptr : BYTE* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn NetServerTransportAddEx(
    servername: [*c]const u16, // LPWSTR optional
    level: u32, // DWORD
    bufptr: [*c]u8 // BYTE*
) callconv(std.os.windows.WINAPI) u32;
proc NetServerTransportAddEx(
    servername: WideCString,  # LPWSTR optional
    level: uint32,  # DWORD
    bufptr: ptr uint8  # BYTE*
): uint32 {.importc: "NetServerTransportAddEx", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetServerTransportAddEx(
    const(wchar)* servername,   // LPWSTR optional
    uint level,   // DWORD
    ubyte* bufptr   // BYTE*
);
ccall((:NetServerTransportAddEx, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt8}),
      servername, level, bufptr)
# servername : LPWSTR optional -> Cwstring
# level : DWORD -> UInt32
# bufptr : BYTE* -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetServerTransportAddEx(
    const uint16_t* servername,
    uint32_t level,
    uint8_t* bufptr);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetServerTransportAddEx(servername, level, bufptr)
-- servername : LPWSTR optional
-- level : DWORD
-- bufptr : BYTE*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetServerTransportAddEx = lib.func('__stdcall', 'NetServerTransportAddEx', 'uint32_t', ['str16', 'uint32_t', 'uint8_t *']);
// NetServerTransportAddEx(servername, level, bufptr)
// servername : LPWSTR optional -> 'str16'
// level : DWORD -> 'uint32_t'
// bufptr : BYTE* -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetServerTransportAddEx: { parameters: ["buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.NetServerTransportAddEx(servername, level, bufptr)
// servername : LPWSTR optional -> "buffer"
// level : DWORD -> "u32"
// bufptr : BYTE* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetServerTransportAddEx(
    const uint16_t* servername,
    uint32_t level,
    uint8_t* bufptr);
C, "NETAPI32.dll");
// $ffi->NetServerTransportAddEx(servername, level, bufptr);
// servername : LPWSTR optional
// level : DWORD
// bufptr : BYTE*
// 構造体/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 Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
    int NetServerTransportAddEx(
        WString servername,   // LPWSTR optional
        int level,   // DWORD
        byte[] bufptr   // BYTE*
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetServerTransportAddEx = NetServerTransportAddEx(
    servername : UInt16*,   # LPWSTR optional
    level : UInt32,   # DWORD
    bufptr : UInt8*   # BYTE*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetServerTransportAddExNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef NetServerTransportAddExDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>);
final NetServerTransportAddEx = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetServerTransportAddExNative, NetServerTransportAddExDart>('NetServerTransportAddEx');
// servername : LPWSTR optional -> Pointer<Utf16>
// level : DWORD -> Uint32
// bufptr : BYTE* -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetServerTransportAddEx(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer   // BYTE*
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetServerTransportAddEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetServerTransportAddEx"
  c_NetServerTransportAddEx :: CWString -> Word32 -> Ptr Word8 -> IO Word32
-- servername : LPWSTR optional -> CWString
-- level : DWORD -> Word32
-- bufptr : BYTE* -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netservertransportaddex =
  foreign "NetServerTransportAddEx"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : BYTE* -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetServerTransportAddEx" net-server-transport-add-ex :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (level :uint32)   ; DWORD
  (bufptr :pointer))   ; BYTE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetServerTransportAddEx = Win32::API::More->new('NETAPI32',
    'DWORD NetServerTransportAddEx(LPCWSTR servername, DWORD level, LPVOID bufptr)');
# my $ret = $NetServerTransportAddEx->Call($servername, $level, $bufptr);
# servername : LPWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目