ホーム › NetworkManagement.NetManagement › NetGroupAdd

NetGroupAdd

関数

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

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

level

DWORD

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

値	意味
0	グローバルグループ名を指定します。buf パラメーターには、 GROUP_INFO_0 構造体へのポインターが格納されます。
1	グローバルグループ名とコメントを指定します。buf パラメーターには、 GROUP_INFO_1 構造体へのポインターが格納されます。
2	グローバルグループに関する詳細情報を指定します。buf パラメーターには、 GROUP_INFO_2 構造体へのポインターが格納されます。Windows XP 以降では、代わりに GROUP_INFO_3 を使用することをお勧めします。
3	グローバルグループに関する詳細情報を指定します。buf パラメーターには、 GROUP_INFO_3 構造体へのポインターが格納されます。 Windows 2000: このレベルはサポートされていません。

buf

BYTE*

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

parm_err

DWORD*

outoptional

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	ユーザーには、要求された情報へのアクセス権がありません。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_GroupExists	グローバルグループは既に存在します。
NERR_NotPrimary	この操作は、ドメインのプライマリドメインコントローラーでのみ許可されます。
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
NERR_SpeGroupOp	この操作は、特定の特殊なグループでは許可されません。これらのグループには、ユーザーグループ、管理者グループ、ローカルグループ、ゲストグループが含まれます。

解説(Remarks)

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

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 の範囲の文字も含めることはできません。

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

各言語での呼び出し定義

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

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

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetGroupAdd(
    [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 NetGroupAdd(
    <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 NetGroupAdd 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

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

#uselib "NETAPI32.dll"
#func global NetGroupAdd "NetGroupAdd" sptr, sptr, sptr, sptr
; NetGroupAdd 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 NetGroupAdd "NetGroupAdd" wstr, int, var, var
; res = NetGroupAdd(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 NetGroupAdd "NetGroupAdd" wstr, int, sptr, sptr
; res = NetGroupAdd(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(変数))。