ホーム › NetworkManagement.NetManagement › NetLocalGroupAdd

NetLocalGroupAdd

関数

サーバーに新しいローカルグループを追加する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

level

DWORD

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

値	意味
0	ローカルグループ名です。buf パラメーターは LOCALGROUP_INFO_0 構造体を指します。
1	ローカルグループ名と、グループに関連付けるコメントです。buf パラメーターは LOCALGROUP_INFO_1 構造体を指します。

buf

BYTE*

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

parm_err

DWORD*

outoptional

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

戻り値の型: DWORD

公式ドキュメント

NetLocalGroupAdd 関数は、セキュリティデータベース(セキュリティアカウントマネージャー (SAM) データベース、ドメインコントローラーの場合は Active Directory)にローカルグループを作成します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	呼び出し元が、この操作を完了するための適切なアクセス権を持っていません。
ERROR_ALIAS_EXISTS	指定されたローカルグループは既に存在します。このエラーは、buf パラメーターが指す構造体のグループ名メンバーが、既にエイリアスとして使用されている場合に返されます。
ERROR_INVALID_LEVEL	level パラメーターが無効です。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。このエラーは、buf パラメーターが指す構造体のメンバーのいずれか 1 つ以上が無効である場合に返されます。
NERR_GroupExists	グループ名が既に存在します。このエラーは、buf パラメーターが指す構造体のグループ名メンバーが、既にグループ名として使用されている場合に返されます。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_NotPrimary	この操作は、ドメインのプライマリドメインコントローラーでのみ許可されます。
NERR_UserExists	ユーザー名が既に存在します。このエラーは、buf パラメーターが指す構造体のグループ名メンバーが、既にユーザー名として使用されている場合に返されます。

解説(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 クラスの子オブジェクトを作成できる必要があります。

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

NetLocalGroupAdd 関数が ERROR_INVALID_PARAMETER を返し、かつ parm_err パラメーターに NULL ポインターが渡されなかった場合、戻り時に parm_err パラメーターは、無効であるローカルグループ情報構造体の最初のメンバーを示します。ローカルグループ情報構造体の形式は level パラメーターで指定されます。ローカルグループ情報構造体へのポインターは buf パラメーターで渡されます。次の表は、parm_err パラメーターで返される可能性のある値と、対応するエラーのある構造体メンバーを示しています。

値	メンバー
LOCALGROUP_NAME_PARMNUM	level パラメーターが 0 の場合、LOCALGROUP_INFO_0 構造体の lgrpi0_name メンバーが無効でした。 level パラメーターが 1 の場合、LOCALGROUP_INFO_1 構造体の lgrpi1_name メンバーが無効でした。
LOCALGROUP_COMMENT_PARMNUM	level パラメーターが 1 の場合、LOCALGROUP_INFO_1 構造体の lgrpi1_comment メンバーが無効でした。

ドメインコントローラーおよび 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 NetLocalGroupAdd(
    LPCWSTR servername,   // optional
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);

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

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

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

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

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

出力引数:

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