ホーム › NetworkManagement.NetManagement › NetLocalGroupGetMembers

NetLocalGroupGetMembers

関数

ローカルグループに所属するメンバーの一覧を取得する。

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

シグネチャ

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

DWORD NetLocalGroupGetMembers(
    LPCWSTR servername,   // optional
    LPCWSTR localgroupname,
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    UINT_PTR* resumehandle   // optional
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

localgroupname

LPCWSTR

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

level

DWORD

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

値	意味
0	ローカルグループメンバーに関連付けられたセキュリティ識別子(SID)を返します。bufptr パラメーターは、 LOCALGROUP_MEMBERS_INFO_0 構造体の配列を指します。
1	ローカルグループメンバーに関連付けられた SID とアカウント情報を返します。bufptr パラメーターは、 LOCALGROUP_MEMBERS_INFO_1 構造体の配列を指します。
2	ローカルグループメンバーに関連付けられた SID、アカウント情報、およびドメイン名を返します。bufptr パラメーターは、 LOCALGROUP_MEMBERS_INFO_2 構造体の配列を指します。
3	ローカルグループメンバーのアカウント名とドメイン名を返します。bufptr パラメーターは、 LOCALGROUP_MEMBERS_INFO_3 構造体の配列を指します。

bufptr

BYTE**

out

返される情報構造体を受け取るアドレスへのポインターです。このデータの形式は、level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 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

既存のグループメンバー検索を継続するために使用される再開ハンドルを格納する値へのポインターです。このハンドルは、最初の呼び出しではゼロにし、後続の呼び出しでは変更しないでください。このパラメーターが NULL の場合、再開ハンドルは格納されません。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻りコード	説明
ERROR_ACCESS_DENIED	ユーザーが要求された情報にアクセスする権限を持っていません。
NERR_InvalidComputer	コンピューター名が無効です。
ERROR_MORE_DATA	さらに多くのエントリが利用可能です。すべてのエントリを受け取るのに十分な大きさのバッファーを指定してください。
ERROR_NO_SUCH_ALIAS	指定されたローカルグループが存在しません。

解説(Remarks)

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

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

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

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

この関数が ERROR_MORE_DATA を返した場合は、ERROR_SUCCESS または NERR_success が返されるまで繰り返し呼び出す必要があります。これを怠ると、RPC 接続のリークが発生する可能性があります。

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

各言語での呼び出し定義

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

DWORD NetLocalGroupGetMembers(
    LPCWSTR servername,   // optional
    LPCWSTR localgroupname,
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    UINT_PTR* resumehandle   // optional
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetLocalGroupGetMembers(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string localgroupname,   // 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 NetLocalGroupGetMembers(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> localgroupname 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
' localgroupname : LPCWSTR
' level : DWORD
' bufptr : BYTE** out
' prefmaxlen : DWORD
' entriesread : DWORD* out
' totalentries : DWORD* out
' resumehandle : UINT_PTR* optional, in/out
Declare PtrSafe Function NetLocalGroupGetMembers Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal localgroupname 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

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

#uselib "NETAPI32.dll"
#func global NetLocalGroupGetMembers "NetLocalGroupGetMembers" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NetLocalGroupGetMembers servername, localgroupname, level, varptr(bufptr), prefmaxlen, varptr(entriesread), varptr(totalentries), varptr(resumehandle)   ; 戻り値は stat
; servername : LPCWSTR optional -> "sptr"
; localgroupname : 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 NetLocalGroupGetMembers "NetLocalGroupGetMembers" wstr, wstr, int, var, int, var, var, var
; res = NetLocalGroupGetMembers(servername, localgroupname, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
; servername : LPCWSTR optional -> "wstr"
; localgroupname : 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 NetLocalGroupGetMembers "NetLocalGroupGetMembers" wstr, wstr, int, sptr, int, sptr, sptr, sptr
; res = NetLocalGroupGetMembers(servername, localgroupname, level, varptr(bufptr), prefmaxlen, varptr(entriesread), varptr(totalentries), varptr(resumehandle))
; servername : LPCWSTR optional -> "wstr"
; localgroupname : 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(変数))。