ホーム › NetworkManagement.NetManagement › NetUserSetGroups

NetUserSetGroups

関数

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

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

シグネチャ

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

DWORD NetUserSetGroups(
    LPCWSTR servername,   // optional
    LPCWSTR username,
    DWORD level,
    BYTE* buf,
    DWORD num_entries
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

username

LPCWSTR

グローバルグループメンバーシップを設定する対象のユーザー名を指定する定数文字列へのポインターです。詳細については、「解説」セクションを参照してください。

level

DWORD

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

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

buf

BYTE*

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

num_entries

DWORD

buf パラメーターが指す配列に含まれるエントリの数です。

戻り値の型: DWORD

公式ドキュメント

NetUserSetGroups 関数は、指定したユーザーアカウントのグローバルグループメンバーシップを設定します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL	システムコールレベルが正しくありません。このエラーは、level パラメーターに 0 または 1 以外の値が指定された場合に返されます。
ERROR_INVALID_PARAMETER	渡されたパラメーターが無効です。このエラーは、num_entries パラメーターが無効だった場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために十分なメモリがありませんでした。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_NotPrimary	この操作は、ドメインのプライマリドメインコントローラーでのみ許可されます。
NERR_GroupNotFound	buf パラメーターが指す GROUP_USERS_INFO_0 構造体の grui0_name、または GROUP_USERS_INFO_1 構造体の grui1_name メンバーで指定されたグループ名が存在しません。
NERR_InternalError	内部エラーが発生しました。
NERR_UserNotFound	ユーザー名が見つかりませんでした。

解説(Remarks)

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

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

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

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

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

例

次のコードサンプルは、 NetUserSetGroups 関数を呼び出してユーザーアカウントのグローバルグループメンバーシップを設定する方法を示しています。このコードサンプルは、 GROUP_USERS_INFO_0 構造体の grui0_name メンバーを設定し、情報レベル 0 を指定して NetUserSetGroups を呼び出します。

#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 = 0;
   GROUP_USERS_INFO_0 gi;
   NET_API_STATUS nStatus;

   if (argc != 4)
   {
      fwprintf(stderr, L"Usage: %s \\\\ServerName UserName GroupName\n", argv[0]);
      exit(1);
   }
   //
   // Fill in the GROUP_USERS_INFO_0 structure member.
   //
   gi.grui0_name = argv[3];
   //
   // Call the NetUserSetGroups function; specify level 0.
   //
   nStatus = NetUserSetGroups(argv[1],
                              argv[2],
                              dwLevel,
                              (LPBYTE)&gi,
                              1);
   //
   // If the call succeeds, inform the user.
   //
   if (nStatus == NERR_Success)
      fwprintf(stderr, L"Group membership has been successful for %s\n", argv[2]);
   //
   // Otherwise, print the system error.
   //
   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 NetUserSetGroups(
    LPCWSTR servername,   // optional
    LPCWSTR username,
    DWORD level,
    BYTE* buf,
    DWORD num_entries
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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