ホーム › NetworkManagement.NetManagement › NetLocalGroupGetInfo

NetLocalGroupGetInfo

関数

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

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

groupname

LPCWSTR

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

level

DWORD

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

値	意味
1	ローカルグループに関連付けられたコメントを返します。bufptr パラメーターは LOCALGROUP_INFO_1 構造体を指します。

bufptr

BYTE**

out

返される情報構造体を受け取るバッファーのアドレスへのポインターです。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetLocalGroupGetInfo 関数は、サーバー上の特定のローカルグループアカウントに関する情報を取得します。

戻り値

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

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

戻りコード	説明
ERROR_ACCESS_DENIED	ユーザーが要求された情報へのアクセス権を持っていません。
NERR_InvalidComputer	コンピューター名が無効です。
NERR_GroupNotFound	指定されたローカルグループが存在しません。

解説(Remarks)

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

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

各言語での呼び出し定義

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

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

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

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

#uselib "NETAPI32.dll"
#func global NetLocalGroupGetInfo "NetLocalGroupGetInfo" sptr, sptr, sptr, sptr
; NetLocalGroupGetInfo 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 NetLocalGroupGetInfo "NetLocalGroupGetInfo" wstr, wstr, int, var
; res = NetLocalGroupGetInfo(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 NetLocalGroupGetInfo "NetLocalGroupGetInfo" wstr, wstr, int, sptr
; res = NetLocalGroupGetInfo(servername, groupname, level, varptr(bufptr))
; servername : LPCWSTR optional -> "wstr"
; groupname : LPCWSTR -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。