ホーム › NetworkManagement.NetManagement › NetGroupEnum

NetGroupEnum

関数

サーバー上のグローバルグループを列挙する。

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

シグネチャ

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

DWORD NetGroupEnum(
    LPCWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    UINT_PTR* resume_handle   // optional
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

level

DWORD

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

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

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

現在の再開位置から列挙できたエントリの総数を受け取る値へのポインターです。エントリの総数はあくまで目安です。エントリの正確な数を判定する方法の詳細については、次の「解説」セクションを参照してください。

resume_handle

UINT_PTR*

inoutoptional

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

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

解説(Remarks)

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

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

この関数は、呼び出し元が Read アクセス権を持つ情報のみを返します。呼び出し元は、Domain オブジェクトに対する List Contents アクセス権、および System コンテナー内にある SAM Server オブジェクトに対する Enumerate Entire SAM Domain アクセス権を持っている必要があります。

グループの正確な総数を判定するには、ツリー全体を列挙する必要がありますが、これはコストの高い操作になる場合があります。ツリー全体を列挙するには、resume_handle パラメーターを使用して連続した呼び出しで列挙を続行し、entriesread パラメーターを使用してグループの総数を累積します。アプリケーションがドメインコントローラーと通信している場合は、この種のデータをより効率的に取得するために ADSI LDAP Provider の使用を検討してください。ADSI LDAP Provider は、さまざまな ADSI インターフェイスをサポートする一連の ADSI オブジェクトを実装します。詳細については、 ADSI Service Providers を参照してください。

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

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

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetGroupEnum(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPCWSTR optional
    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
    resume_handle As IntPtr   ' UINT_PTR* optional, in/out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

NetGroupEnum = ctypes.windll.netapi32.NetGroupEnum
NetGroupEnum.restype = wintypes.DWORD
NetGroupEnum.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    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),  # resume_handle : UINT_PTR* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetGroupEnum = Fiddle::Function.new(
  lib['NetGroupEnum'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    -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,  # resume_handle : UINT_PTR* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetGroupEnum(
        servername: *const u16,  // LPCWSTR optional
        level: u32,  // DWORD
        bufptr: *mut *mut u8,  // BYTE** out
        prefmaxlen: u32,  // DWORD
        entriesread: *mut u32,  // DWORD* out
        totalentries: *mut u32,  // DWORD* out
        resume_handle: *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 NetGroupEnum([MarshalAs(UnmanagedType.LPWStr)] string servername, uint level, IntPtr bufptr, uint prefmaxlen, out uint entriesread, out uint totalentries, IntPtr resume_handle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetGroupEnum' -Namespace Win32 -PassThru
# $api::NetGroupEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resume_handle)

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

出力引数:

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