ホーム › NetworkManagement.NetManagement › NetGroupGetInfo

NetGroupGetInfo

関数

指定したグローバルグループの情報を取得する。

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

シグネチャ

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

DWORD NetGroupGetInfo(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE** bufptr
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

groupname

LPCWSTR

情報を取得する対象のグローバルグループ名を指定する定数文字列へのポインターです。詳細については、以下の「解説」セクションを参照してください。

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 関数を呼び出す必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻りコード	説明
ERROR_ACCESS_DENIED	ユーザーには要求された情報へのアクセス権がありません。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_GroupNotFound	グローバルグループ名が見つかりませんでした。

解説(Remarks)

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

Active Directory を実行しているドメインコントローラーでこの関数を呼び出した場合、アクセスはセキュリティ保護可能オブジェクトのアクセス制御リスト (ACL) に基づいて許可または拒否されます。既定の ACL では、すべての認証済みユーザーと「Pre-Windows 2000 compatible access」グループのメンバーが情報を表示できます。メンバーサーバーまたはワークステーションでこの関数を呼び出した場合は、すべての認証済みユーザーが情報を表示できます。これらのプラットフォームにおける匿名アクセスおよび匿名アクセスの制限については、 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 NetGroupGetInfo(
    LPCWSTR servername,   // optional
    LPCWSTR groupname,
    DWORD level,
    BYTE** bufptr
);

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

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

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

import ctypes
from ctypes import wintypes

NetGroupGetInfo = ctypes.windll.netapi32.NetGroupGetInfo
NetGroupGetInfo.restype = wintypes.DWORD
NetGroupGetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # groupname : LPCWSTR
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetGroupGetInfo = Fiddle::Function.new(
  lib['NetGroupGetInfo'],
  [
    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)

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

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

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

出力引数:

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