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

NetServerSetInfo

関数
指定したサーバーの構成情報を設定する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetServerSetInfo(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE* buf,
    DWORD* ParmError   // optional
);

パラメーター

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

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

意味
101
サーバー名、種類、および関連するソフトウェアを指定します。buf パラメーターは SERVER_INFO_101 構造体を指します。
102
サーバー名、種類、関連するソフトウェア、およびその他の属性を指定します。buf パラメーターは SERVER_INFO_102 構造体を指します。
402
サーバーに関する詳細情報を指定します。buf パラメーターは SERVER_INFO_402 構造体を指します。
403
サーバーに関する詳細情報を指定します。buf パラメーターは SERVER_INFO_403 構造体を指します。

さらに、LAN Manager システムの制約に基づき、レベル 1001 ~ 1006、1009 ~ 1011、1016 ~ 1018、1021、1022、1028、1029、1037、および 1043 が有効です。

bufBYTE*inサーバー情報を受け取るバッファーへのポインターです。このデータの形式は、level パラメーターの値によって異なります。詳細については、 Network Management Function Buffers を参照してください。
ParmErrorDWORD*outoptionalERROR_INVALID_PARAMETER エラーの原因となったサーバー情報構造体の最初のメンバーのインデックスを受け取る値へのポインターです。このパラメーターが NULL の場合、エラー時にインデックスは返されません。詳細については、後述の「解説」セクションを参照してください。

戻り値の型: DWORD

公式ドキュメント

NetServerSetInfo 関数は、サーバーの動作パラメーターを設定します。個別に設定することも、まとめて設定することもできます。情報は、システムの再初期化後も有効なまま残るように格納されます。

戻り値

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

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

戻り値コード 説明
ERROR_ACCESS_DENIED
ユーザーが要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL
level パラメーターに指定された値が無効です。
ERROR_INVALID_PARAMETER
指定されたパラメーターが無効です。詳細については、後述の「解説」セクションを参照してください。
ERROR_NOT_ENOUGH_MEMORY
利用可能なメモリが不足しています。

解説(Remarks)

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

Active Directory 向けのプログラミングを行っている場合、ネットワーク管理サーバー関数を呼び出して実現できる機能と同じ機能を、特定の Active Directory Service Interface (ADSI) メソッドを呼び出すことで実現できる場合があります。詳細については、 IADsComputer を参照してください。

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

メンバー
SV_PLATFORM_ID_PARMNUM sv*_platform_id
SV_NAME_PARMNUM sv*_name
SV_VERSION_MAJOR_PARMNUM sv*_version_major
SV_VERSION_MINOR_PARMNUM sv*_version_minor
SV_TYPE_PARMNUM sv*_type
SV_COMMENT_PARMNUM sv*_comment
SV_USERS_PARMNUM sv*_users
SV_DISC_PARMNUM sv*_disc
SV_HIDDEN_PARMNUM sv*_hidden
SV_ANNOUNCE_PARMNUM sv*_announce
SV_ANNDELTA_PARMNUM sv*_anndelta
SV_USERPATH_PARMNUM sv*_userpath
SV_ULIST_MTIME_PARMNUM sv*_ulist_mtime
SV_GLIST_MTIME_PARMNUM sv*_glist_mtime
SV_ALIST_MTIME_PARMNUM sv*_alist_mtime
SV_ALERTS_PARMNUM sv*_alerts
SV_SECURITY_PARMNUM sv*_security
SV_NUMADMIN_PARMNUM sv*_numadmin
SV_LANMASK_PARMNUM sv*_lanmask
SV_GUESTACC_PARMNUM sv*_guestacc
SV_CHDEVQ_PARMNUM sv*_chdevq
SV_CHDEVJOBS_PARMNUM sv*_chdevjobs
SV_CONNECTIONS_PARMNUM sv*_connections
SV_SHARES_PARMNUM sv*_shares
SV_OPENFILES_PARMNUM sv*_openfiles
SV_SESSOPENS_PARMNUM sv*_sessopens
SV_SESSVCS_PARMNUM sv*_sessvcs
SV_SESSREQS_PARMNUM sv*_sessreqs
SV_OPENSEARCH_PARMNUM sv*_opensearch
SV_ACTIVELOCKS_PARMNUM sv*_activelocks
SV_NUMREQBUF_PARMNUM sv*_numreqbuf
SV_SIZREQBUF_PARMNUM sv*_sizreqbuf
SV_NUMBIGBUF_PARMNUM sv*_numbigbuf
SV_NUMFILETASKS_PARMNUM sv*_numfiletasks
SV_ALERTSCHED_PARMNUM sv*_alertsched
SV_ERRORALERT_PARMNUM sv*_erroralert
SV_LOGONALERT_PARMNUM sv*_logonalert
SV_ACCESSALERT_PARMNUM sv*_accessalert
SV_DISKALERT_PARMNUM sv*_diskalert
SV_NETIOALERT_PARMNUM sv*_netioalert
SV_MAXAUDITSZ_PARMNUM sv*_maxauditsz
SV_SRVHEURISTICS_PARMNUM sv*_srvheuristics
SV_TIMESOURCE_PARMNUM sv*_timesource

使用例

次のコードサンプルは、NetServerSetInfo 関数の呼び出し方法を示しています。このサンプルでは、NetServerSetInfo を呼び出し、level パラメーターに 1005 (必須) を指定して、SERVER_INFO_1005 構造体の sv1005_comment メンバーを設定します。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 1005;
   SERVER_INFO_1005 si;
   NET_API_STATUS nStatus;

   if (argc != 3)
   {
      fwprintf(stderr, L"Usage: %s \\\\ServerName Comment\n", argv[0]);
      exit(1);
   }
   //
   // Fill in SERVER_INFO_1005 structure member.
   //
   si.sv1005_comment = (LPTSTR) argv[2];
   //
   // Call the NetServerSetInfo function, 
   //  specifying level 1005.
   //
   nStatus = NetServerSetInfo(argv[1],
                              dwLevel,
                              (LPBYTE)&si,
                              NULL);
   //
   // Display the result of the call.
   //
   if (nStatus == NERR_Success)
      fwprintf(stderr, L"Comment reset\n", argv[2]);
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   return 0;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

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

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetServerSetInfo = netapi32.NewProc("NetServerSetInfo")
)

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

extern "netapi32" fn NetServerSetInfo(
    servername: [*c]const u16, // LPWSTR optional
    level: u32, // DWORD
    buf: [*c]u8, // BYTE*
    ParmError: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc NetServerSetInfo(
    servername: WideCString,  # LPWSTR optional
    level: uint32,  # DWORD
    buf: ptr uint8,  # BYTE*
    ParmError: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "NetServerSetInfo", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetServerSetInfo(
    const(wchar)* servername,   // LPWSTR optional
    uint level,   // DWORD
    ubyte* buf,   // BYTE*
    uint* ParmError   // DWORD* optional, out
);
ccall((:NetServerSetInfo, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt8}, Ptr{UInt32}),
      servername, level, buf, ParmError)
# servername : LPWSTR optional -> Cwstring
# level : DWORD -> UInt32
# buf : BYTE* -> Ptr{UInt8}
# ParmError : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetServerSetInfo(
    const uint16_t* servername,
    uint32_t level,
    uint8_t* buf,
    uint32_t* ParmError);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetServerSetInfo(servername, level, buf, ParmError)
-- servername : LPWSTR optional
-- level : DWORD
-- buf : BYTE*
-- ParmError : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetServerSetInfo = lib.func('__stdcall', 'NetServerSetInfo', 'uint32_t', ['str16', 'uint32_t', 'uint8_t *', 'uint32_t *']);
// NetServerSetInfo(servername, level, buf, ParmError)
// servername : LPWSTR optional -> 'str16'
// level : DWORD -> 'uint32_t'
// buf : BYTE* -> 'uint8_t *'
// ParmError : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetServerSetInfo: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetServerSetInfo(servername, level, buf, ParmError)
// servername : LPWSTR optional -> "buffer"
// level : DWORD -> "u32"
// buf : BYTE* -> "pointer"
// ParmError : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetServerSetInfo(
    const uint16_t* servername,
    uint32_t level,
    uint8_t* buf,
    uint32_t* ParmError);
C, "NETAPI32.dll");
// $ffi->NetServerSetInfo(servername, level, buf, ParmError);
// servername : LPWSTR optional
// level : DWORD
// buf : BYTE*
// ParmError : 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 NetServerSetInfo(
        WString servername,   // LPWSTR optional
        int level,   // DWORD
        byte[] buf,   // BYTE*
        IntByReference ParmError   // DWORD* optional, out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetServerSetInfo = NetServerSetInfo(
    servername : UInt16*,   # LPWSTR optional
    level : UInt32,   # DWORD
    buf : UInt8*,   # BYTE*
    ParmError : 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 NetServerSetInfoNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef NetServerSetInfoDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>, Pointer<Uint32>);
final NetServerSetInfo = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetServerSetInfoNative, NetServerSetInfoDart>('NetServerSetInfo');
// servername : LPWSTR optional -> Pointer<Utf16>
// level : DWORD -> Uint32
// buf : BYTE* -> Pointer<Uint8>
// ParmError : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetServerSetInfo(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  buf: Pointer;   // BYTE*
  ParmError: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetServerSetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let netserversetinfo =
  foreign "NetServerSetInfo"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* buf : BYTE* -> (ptr uint8_t) *)
(* ParmError : 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 ("NetServerSetInfo" net-server-set-info :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (level :uint32)   ; DWORD
  (buf :pointer)   ; BYTE*
  (parm-error :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetServerSetInfo = Win32::API::More->new('NETAPI32',
    'DWORD NetServerSetInfo(LPCWSTR servername, DWORD level, LPVOID buf, LPVOID ParmError)');
# my $ret = $NetServerSetInfo->Call($servername, $level, $buf, $ParmError);
# servername : LPWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# buf : BYTE* -> LPVOID
# ParmError : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目