NetWkstaSetInfo
関数シグネチャ
// NETAPI32.dll
#include <windows.h>
DWORD NetWkstaSetInfo(
LPWSTR servername, // optional
DWORD level,
BYTE* buffer,
DWORD* parm_err // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| servername | LPWSTR | inoptional | 関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインターです。このパラメーターが NULL の場合、ローカルコンピューターが使用されます。 | ||||||||||
| level | DWORD | in | データの情報レベルです。このパラメーターには次のいずれかの値を指定できます。
レベル 1010~1013、1018、1023、1027、1028、1032、1033、1035、または 1041~1062 は設定しないでください。 | ||||||||||
| buffer | BYTE* | in | データを指定するバッファーへのポインターです。このデータの形式は level パラメーターの値に依存します。詳細については、 Network Management Function Buffers を参照してください。 | ||||||||||
| parm_err | DWORD* | outoptional | ERROR_INVALID_PARAMETER エラーの原因となったワークステーション情報構造体の最初のメンバーのインデックスを受け取る値へのポインターです。このパラメーターが NULL の場合、エラー時にインデックスは返されません。詳細については、「解説」の節を参照してください。 |
戻り値の型: DWORD
公式ドキュメント
NetWkstaSetInfo 関数は、システムの再初期化後も有効であり続ける情報をワークステーションに構成します。
戻り値
関数が成功した場合、戻り値は NERR_Success です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻り値コード | 説明 |
|---|---|
| ユーザーが要求された情報にアクセスする権限を持っていません。 | |
| 関数パラメーターのいずれかが無効です。詳細については、次の「解説」の節を参照してください。 |
解説(Remarks)
リモートサーバー上で NetWkstaSetInfo 関数を正常に実行できるのは、Administrators グループのメンバーのみです。
NetWkstaSetInfo 関数は、ローカルシステムまたはリモートシステム上の Workstation サービスを呼び出します。NetWkstaSetInfo 関数を使用して実際に変更できるのは、WKSTA_INFO_502 構造体のメンバーのうち限られた数のみです。Workstation サービスによって無視されるメンバーを設定してもエラーは返されません。Workstation サービスは主にレジストリの設定を使用して構成されます。
ローカルシステムで構成情報を設定するには、NetWkstaSetInfo 関数の代わりに NetWkstaUserSetInfo 関数を使用できます。NetWkstaUserSetInfo 関数は Local Security Authority (LSA) を呼び出します。
NetWkstaSetInfo 関数が ERROR_INVALID_PARAMETER を返した場合、parm_err パラメーターを使用して、無効であったワークステーション情報構造体の最初のメンバーを示すことができます。(ワークステーション情報構造体は WKSTA_INFO_ で始まり、その形式は level パラメーターによって指定されます。)次の表は、parm_err パラメーターで返される可能性のある値と、対応するエラーのある構造体メンバーの一覧です。(プレフィックス wki*_ は、メンバーが複数のプレフィックス、たとえば wki100_ や wki402_ で始まる可能性があることを示します。)
Workstation サービスのパラメーター設定は、以前 LAN Manager で使用されていた LanMan.ini ファイルではなく、レジストリに格納されます。NetWkstaSetInfo 関数は LanMan.ini ファイル内の値を変更しません。Workstation サービスが停止して再起動されると、ワークステーションのパラメーターはレジストリで指定されている既定値にリセットされます(コマンドライン パラメーターによって上書きされる場合を除きます)。以前の NetWkstaSetInfo の呼び出しによって設定された値は、ワークステーションのパラメーターがリセットされると上書きされる可能性があります。
例
次のコードサンプルは、NetServerSetInfo 関数の呼び出しを使用して、ワークステーションに関連付けられたセッションタイムアウト値を設定する方法を示しています。(セッションタイムアウトは、サーバーが非アクティブなセッションを切断するまで待機する秒数です。)このコードでは情報レベル 502 (WKSTA_INFO_502) を指定しています。
#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[])
{
LPWKSTA_INFO_502 pBuf = NULL;
WKSTA_INFO_502 wi;
DWORD dwLevel = 502;
NET_API_STATUS nStatus;
LPWSTR pszServerName = NULL;
if ((argc < 2) || (argc > 3))
{
fwprintf(stderr, L"Usage: %s [\\\\ServerName] SessionTimeOut\n", argv[0]);
exit(1);
}
if (argc == 3)
pszServerName = argv[1];
//
// Retrieve the current settings.
//
nStatus = NetWkstaGetInfo(pszServerName,
dwLevel,
(LPBYTE *)&pBuf);
if (nStatus != NERR_Success)
{
fprintf(stderr, "A system error has occurred (NetWkstaGetInfo): %d\n", nStatus);
return -1;
}
if (pBuf != NULL)
{
//
// Copy the existing settings to the new structure,
// and free the buffer.
//
CopyMemory(&wi, pBuf, sizeof(wi));
NetApiBufferFree(pBuf);
}
else
{
fprintf(stderr, "Memory invalid!\n");
return -1;
}
//
// Set a new session time-out value by
// calling the NetWkstaSetInfo function.
//
wi.wki502_sess_timeout = _wtoi(argv[argc-1]);
nStatus = NetWkstaSetInfo(pszServerName,
dwLevel,
(LPBYTE)&wi,
NULL);
//
// Display the result of the call.
//
if (nStatus == NERR_Success)
fwprintf(stderr, L"Workstation information reset: session time-out = %d\n", _wtoi(argv[argc-1]));
else
fprintf(stderr, "A system error has occurred (NetWkstaSetInfo): %d\n", nStatus);
return 0;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// NETAPI32.dll
#include <windows.h>
DWORD NetWkstaSetInfo(
LPWSTR servername, // optional
DWORD level,
BYTE* buffer,
DWORD* parm_err // optional
);[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetWkstaSetInfo(
[MarshalAs(UnmanagedType.LPWStr)] string servername, // LPWSTR optional
uint level, // DWORD
IntPtr buffer, // BYTE*
IntPtr parm_err // DWORD* optional, out
);<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetWkstaSetInfo(
<MarshalAs(UnmanagedType.LPWStr)> servername As String, ' LPWSTR optional
level As UInteger, ' DWORD
buffer As IntPtr, ' BYTE*
parm_err As IntPtr ' DWORD* optional, out
) As UInteger
End Function' servername : LPWSTR optional
' level : DWORD
' buffer : BYTE*
' parm_err : DWORD* optional, out
Declare PtrSafe Function NetWkstaSetInfo Lib "netapi32" ( _
ByVal servername As LongPtr, _
ByVal level As Long, _
ByVal buffer 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
NetWkstaSetInfo = ctypes.windll.netapi32.NetWkstaSetInfo
NetWkstaSetInfo.restype = wintypes.DWORD
NetWkstaSetInfo.argtypes = [
wintypes.LPCWSTR, # servername : LPWSTR optional
wintypes.DWORD, # level : DWORD
ctypes.POINTER(ctypes.c_ubyte), # buffer : BYTE*
ctypes.POINTER(wintypes.DWORD), # parm_err : DWORD* optional, out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('NETAPI32.dll')
NetWkstaSetInfo = Fiddle::Function.new(
lib['NetWkstaSetInfo'],
[
Fiddle::TYPE_VOIDP, # servername : LPWSTR optional
-Fiddle::TYPE_INT, # level : DWORD
Fiddle::TYPE_VOIDP, # buffer : BYTE*
Fiddle::TYPE_VOIDP, # parm_err : DWORD* optional, out
],
-Fiddle::TYPE_INT)#[link(name = "netapi32")]
extern "system" {
fn NetWkstaSetInfo(
servername: *mut u16, // LPWSTR optional
level: u32, // DWORD
buffer: *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 NetWkstaSetInfo([MarshalAs(UnmanagedType.LPWStr)] string servername, uint level, IntPtr buffer, IntPtr parm_err);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetWkstaSetInfo' -Namespace Win32 -PassThru
# $api::NetWkstaSetInfo(servername, level, buffer, parm_err)#uselib "NETAPI32.dll"
#func global NetWkstaSetInfo "NetWkstaSetInfo" sptr, sptr, sptr, sptr
; NetWkstaSetInfo servername, level, varptr(buffer), varptr(parm_err) ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; level : DWORD -> "sptr"
; buffer : BYTE* -> "sptr"
; parm_err : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "NETAPI32.dll" #cfunc global NetWkstaSetInfo "NetWkstaSetInfo" wstr, int, var, var ; res = NetWkstaSetInfo(servername, level, buffer, parm_err) ; servername : LPWSTR optional -> "wstr" ; level : DWORD -> "int" ; buffer : BYTE* -> "var" ; parm_err : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll" #cfunc global NetWkstaSetInfo "NetWkstaSetInfo" wstr, int, sptr, sptr ; res = NetWkstaSetInfo(servername, level, varptr(buffer), varptr(parm_err)) ; servername : LPWSTR optional -> "wstr" ; level : DWORD -> "int" ; buffer : BYTE* -> "sptr" ; parm_err : DWORD* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD NetWkstaSetInfo(LPWSTR servername, DWORD level, BYTE* buffer, DWORD* parm_err) #uselib "NETAPI32.dll" #cfunc global NetWkstaSetInfo "NetWkstaSetInfo" wstr, int, var, var ; res = NetWkstaSetInfo(servername, level, buffer, parm_err) ; servername : LPWSTR optional -> "wstr" ; level : DWORD -> "int" ; buffer : BYTE* -> "var" ; parm_err : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD NetWkstaSetInfo(LPWSTR servername, DWORD level, BYTE* buffer, DWORD* parm_err) #uselib "NETAPI32.dll" #cfunc global NetWkstaSetInfo "NetWkstaSetInfo" wstr, int, intptr, intptr ; res = NetWkstaSetInfo(servername, level, varptr(buffer), varptr(parm_err)) ; servername : LPWSTR optional -> "wstr" ; level : DWORD -> "int" ; buffer : BYTE* -> "intptr" ; parm_err : DWORD* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
procNetWkstaSetInfo = netapi32.NewProc("NetWkstaSetInfo")
)
// servername (LPWSTR optional), level (DWORD), buffer (BYTE*), parm_err (DWORD* optional, out)
r1, _, err := procNetWkstaSetInfo.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
uintptr(level),
uintptr(buffer),
uintptr(parm_err),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction NetWkstaSetInfo(
servername: PWideChar; // LPWSTR optional
level: DWORD; // DWORD
buffer: Pointer; // BYTE*
parm_err: Pointer // DWORD* optional, out
): DWORD; stdcall;
external 'NETAPI32.dll' name 'NetWkstaSetInfo';result := DllCall("NETAPI32\NetWkstaSetInfo"
, "WStr", servername ; LPWSTR optional
, "UInt", level ; DWORD
, "Ptr", buffer ; BYTE*
, "Ptr", parm_err ; DWORD* optional, out
, "UInt") ; return: DWORD●NetWkstaSetInfo(servername, level, buffer, parm_err) = DLL("NETAPI32.dll", "dword NetWkstaSetInfo(char*, dword, void*, void*)")
# 呼び出し: NetWkstaSetInfo(servername, level, buffer, parm_err)
# servername : LPWSTR optional -> "char*"
# level : DWORD -> "dword"
# buffer : BYTE* -> "void*"
# parm_err : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "netapi32" fn NetWkstaSetInfo(
servername: [*c]const u16, // LPWSTR optional
level: u32, // DWORD
buffer: [*c]u8, // BYTE*
parm_err: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;proc NetWkstaSetInfo(
servername: WideCString, # LPWSTR optional
level: uint32, # DWORD
buffer: ptr uint8, # BYTE*
parm_err: ptr uint32 # DWORD* optional, out
): uint32 {.importc: "NetWkstaSetInfo", stdcall, dynlib: "NETAPI32.dll".}pragma(lib, "netapi32");
extern(Windows)
uint NetWkstaSetInfo(
const(wchar)* servername, // LPWSTR optional
uint level, // DWORD
ubyte* buffer, // BYTE*
uint* parm_err // DWORD* optional, out
);ccall((:NetWkstaSetInfo, "NETAPI32.dll"), stdcall, UInt32,
(Cwstring, UInt32, Ptr{UInt8}, Ptr{UInt32}),
servername, level, buffer, parm_err)
# servername : LPWSTR optional -> Cwstring
# level : DWORD -> UInt32
# buffer : BYTE* -> Ptr{UInt8}
# parm_err : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t NetWkstaSetInfo(
const uint16_t* servername,
uint32_t level,
uint8_t* buffer,
uint32_t* parm_err);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetWkstaSetInfo(servername, level, buffer, parm_err)
-- servername : LPWSTR optional
-- level : DWORD
-- buffer : BYTE*
-- parm_err : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetWkstaSetInfo = lib.func('__stdcall', 'NetWkstaSetInfo', 'uint32_t', ['str16', 'uint32_t', 'uint8_t *', 'uint32_t *']);
// NetWkstaSetInfo(servername, level, buffer, parm_err)
// servername : LPWSTR optional -> 'str16'
// level : DWORD -> 'uint32_t'
// buffer : BYTE* -> 'uint8_t *'
// parm_err : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("NETAPI32.dll", {
NetWkstaSetInfo: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetWkstaSetInfo(servername, level, buffer, parm_err)
// servername : LPWSTR optional -> "buffer"
// level : DWORD -> "u32"
// buffer : BYTE* -> "pointer"
// parm_err : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t NetWkstaSetInfo(
const uint16_t* servername,
uint32_t level,
uint8_t* buffer,
uint32_t* parm_err);
C, "NETAPI32.dll");
// $ffi->NetWkstaSetInfo(servername, level, buffer, parm_err);
// servername : LPWSTR optional
// level : DWORD
// buffer : 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 NetWkstaSetInfo(
WString servername, // LPWSTR optional
int level, // DWORD
byte[] buffer, // BYTE*
IntByReference parm_err // DWORD* optional, out
);
}@[Link("netapi32")]
lib LibNETAPI32
fun NetWkstaSetInfo = NetWkstaSetInfo(
servername : UInt16*, # LPWSTR optional
level : UInt32, # DWORD
buffer : 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 NetWkstaSetInfoNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef NetWkstaSetInfoDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>, Pointer<Uint32>);
final NetWkstaSetInfo = DynamicLibrary.open('NETAPI32.dll')
.lookupFunction<NetWkstaSetInfoNative, NetWkstaSetInfoDart>('NetWkstaSetInfo');
// servername : LPWSTR optional -> Pointer<Utf16>
// level : DWORD -> Uint32
// buffer : BYTE* -> Pointer<Uint8>
// parm_err : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function NetWkstaSetInfo(
servername: PWideChar; // LPWSTR optional
level: DWORD; // DWORD
buffer: Pointer; // BYTE*
parm_err: Pointer // DWORD* optional, out
): DWORD; stdcall;
external 'NETAPI32.dll' name 'NetWkstaSetInfo';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NetWkstaSetInfo"
c_NetWkstaSetInfo :: CWString -> Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- servername : LPWSTR optional -> CWString
-- level : DWORD -> Word32
-- buffer : BYTE* -> Ptr Word8
-- parm_err : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let netwkstasetinfo =
foreign "NetWkstaSetInfo"
((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* buffer : 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 ("NetWkstaSetInfo" net-wksta-set-info :convention :stdcall) :uint32
(servername (:string :encoding :utf-16le)) ; LPWSTR optional
(level :uint32) ; DWORD
(buffer :pointer) ; BYTE*
(parm-err :pointer)) ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NetWkstaSetInfo = Win32::API::More->new('NETAPI32',
'DWORD NetWkstaSetInfo(LPCWSTR servername, DWORD level, LPVOID buffer, LPVOID parm_err)');
# my $ret = $NetWkstaSetInfo->Call($servername, $level, $buffer, $parm_err);
# servername : LPWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# buffer : BYTE* -> LPVOID
# parm_err : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f NetWkstaGetInfo — ワークステーションの構成情報を取得する。
- f NetWkstaUserGetInfo — 現在ログオン中のユーザーのワークステーション情報を取得する。
- f NetWkstaUserSetInfo — 現在ログオン中のユーザーのワークステーション情報を設定する。