ホーム › NetworkManagement.NetManagement › NetLocalGroupSetInfo

NetLocalGroupSetInfo

関数

指定したローカルグループの情報を設定する。

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

シグネチャ

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

DWORD NetLocalGroupSetInfo(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

groupname

LPCWSTR

変更するローカルグループアカウントの名前を指定する定数文字列へのポインターです。詳細については、後述の「Remarks」セクションを参照してください。

level

DWORD

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

Value	Meaning
0	ローカルグループ名を指定します。buf パラメーターは LOCALGROUP_INFO_0 構造体を指します。既存のローカルグループの名前を変更するには、このレベルを使用します。
1	ローカルグループ名と、グループに関連付けるコメントを指定します。buf パラメーターは LOCALGROUP_INFO_1 構造体を指します。
1002	ローカルグループに関連付けるコメントを指定します。buf パラメーターは LOCALGROUP_INFO_1002 構造体を指します。

buf

BYTE*

ローカルグループ情報を格納するバッファーへのポインターです。このデータの形式は level パラメーターの値によって異なります。詳細については、 Network Management Function Buffers を参照してください。

parm_err

DWORD*

outoptional

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

戻り値の型: DWORD

公式ドキュメント

NetLocalGroupSetInfo 関数は、既存のローカルグループの名前を変更します。また、この関数はローカルグループにコメントを関連付けることもできます。

戻り値

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

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

Return code	Description
ERROR_ACCESS_DENIED	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_PARAMETER	関数パラメーターのいずれかが無効です。詳細については、後述の「Remarks」セクションを参照してください。
ERROR_NO_SUCH_ALIAS	指定されたローカルグループは存在しません。
NERR_NotPrimary	この操作は、ドメインのプライマリドメインコントローラー上でのみ許可されます。
NERR_InvalidComputer	コンピューター名が無効です。

解説(Remarks)

Active Directory を実行しているドメインコントローラー上でこの関数を呼び出す場合、アクセスの許可または拒否は、セキュリティ保護可能なオブジェクトのアクセス制御リスト (ACL) に基づいて決定されます。既定の ACL では、Domain Admins と Account Operators のみがこの関数を呼び出すことができます。メンバーサーバーまたはワークステーション上では、Administrators と Power Users のみがこの関数を呼び出すことができます。詳細については、 Security Requirements for the Network Management Functions を参照してください。ACL、ACE、およびアクセストークンの詳細については、 Access Control Model を参照してください。

この関数のアクセスチェックには、LocalGroup オブジェクトのセキュリティ記述子が使用されます。通常、この関数の呼び出しを成功させるには、呼び出し元がオブジェクト全体への書き込みアクセス権を持っている必要があります。

既存のローカルグループの新しい名前を指定するには、 LOCALGROUP_INFO_0 を指定して NetLocalGroupSetInfo を呼び出し、lgrpi0_name メンバーを使用して値を指定します。 LOCALGROUP_INFO_1 を指定して NetLocalGroupSetInfo 関数を呼び出し、lgrpi1_name メンバーを使用して新しい値を指定した場合、その値は無視されます。

NetLocalGroupSetInfo 関数が ERROR_INVALID_PARAMETER を返した場合、parm_err パラメーターを使用して、無効であったローカルグループ情報構造体の最初のメンバーを特定できます。(ローカルグループ情報構造体は LOCALGROUP_INFO_ で始まり、その形式は level パラメーターによって指定されます。) 次の表に、parm_err パラメーターで返される可能性のある値と、エラーが発生した対応する構造体メンバーを示します。(プレフィックス lgrpi*_ は、メンバーが複数のプレフィックス、たとえば lgrpi0_ や lgrpi1_ で始まる可能性があることを示します。)

Value	Member
LOCALGROUP_NAME_PARMNUM	lgrpi*_name
LOCALGROUP_COMMENT_PARMNUM	lgrpi*_comment

ユーザーアカウント名は 20 文字まで、グループ名は 256 文字までに制限されています。さらに、アカウント名はピリオドで終わることはできず、カンマや次の印字可能な文字を含めることはできません: ", /, , [, ], :, |, <, >, +, =, ;, ?, *。また、名前には印字不可能な 1〜31 の範囲の文字を含めることはできません。

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

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

各言語での呼び出し定義

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

DWORD NetLocalGroupSetInfo(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetLocalGroupSetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string groupname,   // LPCWSTR
    uint level,   // DWORD
    IntPtr buf,   // BYTE*
    IntPtr parm_err   // DWORD* optional, out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetLocalGroupSetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> groupname As String,   ' LPCWSTR
    level As UInteger,   ' DWORD
    buf As IntPtr,   ' BYTE*
    parm_err As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

' servername : LPCWSTR optional
' groupname : LPCWSTR
' level : DWORD
' buf : BYTE*
' parm_err : DWORD* optional, out
Declare PtrSafe Function NetLocalGroupSetInfo Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal groupname 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

NetLocalGroupSetInfo = ctypes.windll.netapi32.NetLocalGroupSetInfo
NetLocalGroupSetInfo.restype = wintypes.DWORD
NetLocalGroupSetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # groupname : LPCWSTR
    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')
NetLocalGroupSetInfo = Fiddle::Function.new(
  lib['NetLocalGroupSetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # groupname : LPCWSTR
    -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 NetLocalGroupSetInfo(
        servername: *const u16,  // LPCWSTR optional
        groupname: *const u16,  // LPCWSTR
        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 NetLocalGroupSetInfo([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string groupname, uint level, IntPtr buf, IntPtr parm_err);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetLocalGroupSetInfo' -Namespace Win32 -PassThru
# $api::NetLocalGroupSetInfo(servername, groupname, level, buf, parm_err)

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

出力引数:

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