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

NetWkstaTransportAdd

関数
ワークステーションに新しいネットワークトランスポートプロトコルを追加する。
DLLNETAPI32.dll呼出規約winapi

シグネチャ

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

DWORD NetWkstaTransportAdd(
    CHAR* servername,   // optional
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);

パラメーター

名前方向説明
servernameCHAR*inoptional

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

この文字列は \ で始まる必要があります。

levelDWORDin

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

意味
0
ワークステーションのトランスポートプロトコル情報を指定します。buf パラメーターは WKSTA_TRANSPORT_INFO_0 構造体を指します。
bufBYTE*inデータを指定するバッファーへのポインターです。このデータの形式は level パラメーターの値に依存します。詳細については Network Management Function Buffers を参照してください。
parm_errDWORD*outoptionalERROR_INVALID_PARAMETER エラーの原因となった最初のパラメーターのインデックスを受け取る値へのポインターです。このパラメーターが NULL の場合、エラー時にインデックスは返されません。

戻り値の型: DWORD

公式ドキュメント

サポートされていません。(NetWkstaTransportAdd)

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
ユーザーが要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL
データ構造体情報のレベルを示す level パラメーターが無効です。
ERROR_INVALID_PARAMETER
関数のパラメーターのいずれかが無効です。

解説(Remarks)

Administrators ローカルグループのメンバーのみが NetWkstaTransportAdd 関数を正常に実行できます。

NetWkstaTransportAdd 関数が ERROR_INVALID_PARAMETER を返した場合、parm_err パラメーターを使用して、無効である WKSTA_TRANSPORT_INFO_0 構造体のメンバーを特定できます。次の表は、parm_err パラメーターに返される値と、それに対応するエラーの原因となる構造体メンバーを示します。

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

各言語での呼び出し定義

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

DWORD NetWkstaTransportAdd(
    CHAR* servername,   // optional
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetWkstaTransportAdd(
    IntPtr servername,   // CHAR* optional
    uint level,   // DWORD
    IntPtr buf,   // BYTE*
    IntPtr parm_err   // DWORD* optional, out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetWkstaTransportAdd(
    servername As IntPtr,   ' CHAR* optional
    level As UInteger,   ' DWORD
    buf As IntPtr,   ' BYTE*
    parm_err As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' servername : CHAR* optional
' level : DWORD
' buf : BYTE*
' parm_err : DWORD* optional, out
Declare PtrSafe Function NetWkstaTransportAdd Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal level 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

NetWkstaTransportAdd = ctypes.windll.netapi32.NetWkstaTransportAdd
NetWkstaTransportAdd.restype = wintypes.DWORD
NetWkstaTransportAdd.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # servername : CHAR* optional
    wintypes.DWORD,  # level : 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')
NetWkstaTransportAdd = Fiddle::Function.new(
  lib['NetWkstaTransportAdd'],
  [
    Fiddle::TYPE_VOIDP,  # servername : CHAR* optional
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # buf : BYTE*
    Fiddle::TYPE_VOIDP,  # parm_err : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetWkstaTransportAdd(
        servername: *mut i8,  // CHAR* optional
        level: 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 NetWkstaTransportAdd(IntPtr servername, uint level, IntPtr buf, IntPtr parm_err);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetWkstaTransportAdd' -Namespace Win32 -PassThru
# $api::NetWkstaTransportAdd(servername, level, buf, parm_err)
#uselib "NETAPI32.dll"
#func global NetWkstaTransportAdd "NetWkstaTransportAdd" sptr, sptr, sptr, sptr
; NetWkstaTransportAdd varptr(servername), level, varptr(buf), varptr(parm_err)   ; 戻り値は stat
; servername : CHAR* optional -> "sptr"
; level : DWORD -> "sptr"
; buf : BYTE* -> "sptr"
; parm_err : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global NetWkstaTransportAdd "NetWkstaTransportAdd" var, int, var, var
; res = NetWkstaTransportAdd(servername, level, buf, parm_err)
; servername : CHAR* optional -> "var"
; level : DWORD -> "int"
; buf : BYTE* -> "var"
; parm_err : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD NetWkstaTransportAdd(CHAR* servername, DWORD level, BYTE* buf, DWORD* parm_err)
#uselib "NETAPI32.dll"
#cfunc global NetWkstaTransportAdd "NetWkstaTransportAdd" var, int, var, var
; res = NetWkstaTransportAdd(servername, level, buf, parm_err)
; servername : CHAR* optional -> "var"
; level : DWORD -> "int"
; buf : BYTE* -> "var"
; parm_err : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetWkstaTransportAdd = netapi32.NewProc("NetWkstaTransportAdd")
)

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

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

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

foreign import stdcall safe "NetWkstaTransportAdd"
  c_NetWkstaTransportAdd :: Ptr Int8 -> Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- servername : CHAR* optional -> Ptr Int8
-- level : DWORD -> Word32
-- buf : BYTE* -> Ptr Word8
-- parm_err : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netwkstatransportadd =
  foreign "NetWkstaTransportAdd"
    ((ptr int8_t) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* servername : CHAR* optional -> (ptr int8_t) *)
(* level : DWORD -> uint32_t *)
(* buf : BYTE* -> (ptr uint8_t) *)
(* parm_err : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetWkstaTransportAdd" net-wksta-transport-add :convention :stdcall) :uint32
  (servername :pointer)   ; CHAR* optional
  (level :uint32)   ; DWORD
  (buf :pointer)   ; BYTE*
  (parm-err :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetWkstaTransportAdd = Win32::API::More->new('NETAPI32',
    'DWORD NetWkstaTransportAdd(LPVOID servername, DWORD level, LPVOID buf, LPVOID parm_err)');
# my $ret = $NetWkstaTransportAdd->Call($servername, $level, $buf, $parm_err);
# servername : CHAR* optional -> LPVOID
# level : DWORD -> DWORD
# buf : BYTE* -> LPVOID
# parm_err : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。