ホーム › NetworkManagement.NetManagement › NetGroupSetUsers

NetGroupSetUsers

関数

グローバルグループの所属ユーザーを設定する。

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

シグネチャ

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

DWORD NetGroupSetUsers(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE* buf,
    DWORD totalentries
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

groupname

LPCWSTR

対象となるグローバルグループの名前を指定する定数文字列へのポインター。詳細については、「Remarks」セクションを参照してください。

level

DWORD

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

値	意味
0	buf パラメーターは、ユーザー名を指定する GROUP_USERS_INFO_0 構造体の配列を指します。
1	buf パラメーターは、ユーザー名とグループの属性を指定する GROUP_USERS_INFO_1 構造体の配列を指します。

buf

BYTE*

データを格納するバッファーへのポインター。詳細については、 Network Management Function Buffers を参照してください。

totalentries

DWORD

buf パラメーターが指すバッファー内のエントリ数。

戻り値の型: DWORD

公式ドキュメント

NetGroupSetUsers 関数は、指定したグローバルグループのメンバーシップを設定します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL	システムコールレベルが正しくありません。このエラーは、level パラメーターに 0 または 1 以外の値が指定された場合に返されます。
ERROR_INVALID_PARAMETER	渡されたパラメーターが無効です。このエラーは、totalentries パラメーターが無効な場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために使用できるメモリが不足しています。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_NotPrimary	この操作は、ドメインのプライマリドメインコントローラーでのみ許可されます。
NERR_GroupNotFound	グローバルグループ名が見つかりませんでした。
NERR_InternalError	内部エラーが発生しました。
NERR_SpeGroupOp	この操作は特定の特殊なグループでは許可されません。これらのグループには、ユーザーグループ、管理者グループ、ローカルグループ、ゲストグループが含まれます。
NERR_UserNotFound	ユーザー名が見つかりませんでした。

解説(Remarks)

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

この関数のアクセスチェックには、Group オブジェクトのセキュリティ記述子が使用されます。

NetGroupSetUsers 関数を呼び出すことで、グローバルグループのメンバーシップをまったく新しいメンバーのリストに置き換えることができます。これを行う一般的な手順は次のとおりです。

グローバルグループのメンバーシップを置き換えるには

NetGroupGetUsers 関数を呼び出して、現在のメンバーシップリストを取得します。
返されたメンバーシップリストを変更して、新しいメンバーシップを反映します。
NetGroupSetUsers 関数を呼び出して、古いメンバーシップリストを新しいメンバーシップリストに置き換えます。

既存のグローバルグループに 1 人のユーザーのメンバーシップを付与するには、 NetGroupAddUser 関数を呼び出します。グローバルグループからユーザーを削除するには、 NetGroupDelUser 関数を呼び出します。

ユーザーアカウント名は 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 NetGroupSetUsers(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE* buf,
    DWORD totalentries
);

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

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

' servername : LPCWSTR optional
' groupname : LPCWSTR
' level : DWORD
' buf : BYTE*
' totalentries : DWORD
Declare PtrSafe Function NetGroupSetUsers Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal groupname As LongPtr, _
    ByVal level As Long, _
    ByVal buf As LongPtr, _
    ByVal totalentries As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetGroupSetUsers = ctypes.windll.netapi32.NetGroupSetUsers
NetGroupSetUsers.restype = wintypes.DWORD
NetGroupSetUsers.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # groupname : LPCWSTR
    wintypes.DWORD,  # level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # buf : BYTE*
    wintypes.DWORD,  # totalentries : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetGroupSetUsers = Fiddle::Function.new(
  lib['NetGroupSetUsers'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # groupname : LPCWSTR
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # buf : BYTE*
    -Fiddle::TYPE_INT,  # totalentries : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetGroupSetUsers(
        servername: *const u16,  // LPCWSTR optional
        groupname: *const u16,  // LPCWSTR
        level: u32,  // DWORD
        buf: *mut u8,  // BYTE*
        totalentries: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetGroupSetUsers([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string groupname, uint level, IntPtr buf, uint totalentries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetGroupSetUsers' -Namespace Win32 -PassThru
# $api::NetGroupSetUsers(servername, groupname, level, buf, totalentries)

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

出力引数:

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