ホーム › NetworkManagement.NetManagement › NetGroupGetUsers

NetGroupGetUsers

関数

グローバルグループに所属するユーザーの一覧を取得する。

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

シグネチャ

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

DWORD NetGroupGetUsers(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    UINT_PTR* ResumeHandle   // optional
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

groupname

LPCWSTR

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

level

DWORD

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

値	意味
0	グローバルグループのメンバー名を返します。bufptr パラメーターは GROUP_USERS_INFO_0 構造体の配列を指します。
1	グローバルグループのメンバー名と属性を返します。bufptr パラメーターは GROUP_USERS_INFO_1 構造体の配列を指します。

bufptr

BYTE**

out

情報構造体を受け取るバッファーのアドレスへのポインターです。このバッファーのメモリはシステムが割り当てます。メモリを解放するには NetApiBufferFree 関数を呼び出す必要があります。関数が ERROR_MORE_DATA で失敗した場合でも、バッファーを解放する必要があることに注意してください。

prefmaxlen

DWORD

返されるデータの優先する最大長(バイト単位)です。MAX_PREFERRED_LENGTH を指定すると、関数はデータを保持するのに必要な量のメモリを割り当てます。このパラメーターに別の値を指定すると、関数が返すバイト数を制限できます。バッファーサイズがすべてのエントリを保持するのに不十分な場合、関数は ERROR_MORE_DATA を返します。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

entriesread

DWORD*

out

実際に列挙された要素の数を受け取る値へのポインターです。

totalentries

DWORD*

out

現在の再開位置から列挙可能であったエントリの総数を受け取る値へのポインターです。

ResumeHandle

UINT_PTR*

inoutoptional

既存のユーザー列挙を継続するために使用される再開ハンドルを格納する変数へのポインターです。このハンドルは、最初の呼び出しではゼロにし、以降の呼び出しでは変更しないでください。ResumeHandle パラメーターが NULL の場合、再開ハンドルは格納されません。

戻り値の型: DWORD

公式ドキュメント

NetGroupGetUsers 関数は、セキュリティデータベース(セキュリティアカウントマネージャー(SAM)データベース、ドメインコントローラーの場合は Active Directory)内の特定のグローバルグループのメンバー一覧を取得します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL	システム呼び出しのレベルが正しくありません。このエラーは、level パラメーターに 0 または 1 以外の値が指定された場合に返されます。
ERROR_MORE_DATA	さらにエントリがあります。すべてのエントリを受け取るのに十分な大きさのバッファーを指定してください。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なメモリがありませんでした。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_GroupNotFound	bufptr パラメーターが指す構造体内のグローバルグループ名が見つかりませんでした。
NERR_InternalError	内部エラーが発生しました。

解説(Remarks)

Active Directory を実行しているドメインコントローラー上でこの関数を呼び出す場合、アクセスはセキュリティ保護可能なオブジェクトのアクセス制御リスト(ACL)に基づいて許可または拒否されます。既定の ACL では、認証済みのすべてのユーザーと「Pre-Windows 2000 互換アクセス」グループのメンバーが情報を表示できます。メンバーサーバーまたはワークステーション上でこの関数を呼び出す場合、認証済みのすべてのユーザーが情報を表示できます。これらのプラットフォームでの匿名アクセスおよび匿名アクセスの制限については、 Security Requirements for the Network Management Functions を参照してください。ACL、ACE、およびアクセストークンの詳細については、 Access Control Model を参照してください。

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

既存のグローバルグループに 1 人のユーザーをメンバーとして追加するには、 NetGroupAddUser 関数を呼び出します。グローバルグループからユーザーを削除するには、 NetGroupDelUser 関数を呼び出します。グローバルグループのメンバーシップを置き換える方法については、 NetGroupSetUsers を参照してください。

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

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetGroupGetUsers(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string groupname,   // LPCWSTR
    uint level,   // DWORD
    IntPtr bufptr,   // BYTE** out
    uint prefmaxlen,   // DWORD
    out uint entriesread,   // DWORD* out
    out uint totalentries,   // DWORD* out
    IntPtr ResumeHandle   // UINT_PTR* optional, in/out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetGroupGetUsers(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> groupname As String,   ' LPCWSTR
    level As UInteger,   ' DWORD
    bufptr As IntPtr,   ' BYTE** out
    prefmaxlen As UInteger,   ' DWORD
    <Out> ByRef entriesread As UInteger,   ' DWORD* out
    <Out> ByRef totalentries As UInteger,   ' DWORD* out
    ResumeHandle As IntPtr   ' UINT_PTR* optional, in/out
) As UInteger
End Function

' servername : LPCWSTR optional
' groupname : LPCWSTR
' level : DWORD
' bufptr : BYTE** out
' prefmaxlen : DWORD
' entriesread : DWORD* out
' totalentries : DWORD* out
' ResumeHandle : UINT_PTR* optional, in/out
Declare PtrSafe Function NetGroupGetUsers Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal groupname As LongPtr, _
    ByVal level As Long, _
    ByVal bufptr As LongPtr, _
    ByVal prefmaxlen As Long, _
    ByRef entriesread As Long, _
    ByRef totalentries As Long, _
    ByVal ResumeHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetGroupGetUsers = ctypes.windll.netapi32.NetGroupGetUsers
NetGroupGetUsers.restype = wintypes.DWORD
NetGroupGetUsers.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # groupname : LPCWSTR
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
    wintypes.DWORD,  # prefmaxlen : DWORD
    ctypes.POINTER(wintypes.DWORD),  # entriesread : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # totalentries : DWORD* out
    ctypes.POINTER(ctypes.c_size_t),  # ResumeHandle : UINT_PTR* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetGroupGetUsers = Fiddle::Function.new(
  lib['NetGroupGetUsers'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # groupname : LPCWSTR
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE** out
    -Fiddle::TYPE_INT,  # prefmaxlen : DWORD
    Fiddle::TYPE_VOIDP,  # entriesread : DWORD* out
    Fiddle::TYPE_VOIDP,  # totalentries : DWORD* out
    Fiddle::TYPE_VOIDP,  # ResumeHandle : UINT_PTR* optional, in/out
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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