ホーム › NetworkManagement.NetManagement › NetUserGetGroups

NetUserGetGroups

関数

ユーザーが所属するグローバルグループを取得する。

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

シグネチャ

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

DWORD NetUserGetGroups(
    LPCWSTR servername,   // optional
    LPCWSTR username,
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries
);

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

username

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

取得可能であったエントリの総数を受け取る値へのポインターです。

戻り値の型: DWORD

公式ドキュメント

NetUserGetGroups 関数は、指定したユーザーが属するグローバルグループの一覧を取得します。

戻り値

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

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

戻り値コード	説明
ERROR_ACCESS_DENIED	ユーザーには、要求された情報へのアクセス権がありません。
ERROR_BAD_NETPATH	ネットワークパスが見つかりませんでした。このエラーは、servername パラメーターが見つからなかった場合に返されます。
ERROR_INVALID_LEVEL	システムコールレベルが正しくありません。このエラーは、level パラメーターに 0 または 1 以外の値が指定された場合に返されます。
ERROR_INVALID_NAME	名前の構文が正しくありません。このエラーは、servername パラメーターの先頭または末尾に空白がある場合、または不正な文字が含まれている場合に返されます。
ERROR_MORE_DATA	さらに多くのエントリが利用可能です。すべてのエントリを受け取るのに十分な大きさのバッファーを指定してください。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なメモリがありませんでした。
NERR_InternalError	内部エラーが発生しました。
NERR_UserNotFound	ユーザーが見つかりませんでした。このエラーは、username が見つからなかった場合に返されます。

解説(Remarks)

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

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

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

ユーザーが属するローカルグループの一覧を取得するには、 NetUserGetLocalGroups 関数を呼び出すことができます。ネットワークグループは、Windows NT のシステムグループとは別個の独立したものです。

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

例

次のコードサンプルは、 NetUserGetGroups 関数の呼び出しによって、ユーザーが属するグローバルグループの一覧を取得する方法を示しています。このサンプルは、情報レベル 0 ( GROUP_USERS_INFO_0) を指定して NetUserGetGroups を呼び出します。コードはエントリをループ処理し、ユーザーがメンバーとなっているグローバルグループの名前を出力します。また、利用可能なエントリの総数と、それらが一致しない場合は実際に列挙されたエントリの数も出力します。最後に、コードサンプルはバッファーに割り当てられたメモリを解放します。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <assert.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   LPGROUP_USERS_INFO_0 pBuf = NULL;
   DWORD dwLevel = 0;
   DWORD dwPrefMaxLen = MAX_PREFERRED_LENGTH;
   DWORD dwEntriesRead = 0;
   DWORD dwTotalEntries = 0;
   NET_API_STATUS nStatus;

   if (argc != 3)
   {
      fwprintf(stderr, L"Usage: %s \\\\ServerName UserName\n", argv[0]);
      exit(1);
   }
   //
   // Call the NetUserGetGroups function, specifying level 0.
   //
   nStatus = NetUserGetGroups(argv[1],
                              argv[2],
                              dwLevel,
                              (LPBYTE*)&pBuf,
                              dwPrefMaxLen,
                              &dwEntriesRead,
                              &dwTotalEntries);
   //
   // If the call succeeds,
   //
   if (nStatus == NERR_Success)
   {
      LPGROUP_USERS_INFO_0 pTmpBuf;
      DWORD i;
      DWORD dwTotalCount = 0;

      if ((pTmpBuf = pBuf) != NULL)
      {
         fprintf(stderr, "\nGlobal group(s):\n");
         //
         // Loop through the entries; 
         //  print the name of the global groups 
         //  to which the user belongs.
         //
         for (i = 0; i < dwEntriesRead; i++)
         {
            assert(pTmpBuf != NULL);

            if (pTmpBuf == NULL)
            {
               fprintf(stderr, "An access violation has occurred\n");
               break;
            }

            wprintf(L"\t-- %s\n", pTmpBuf->grui0_name);

            pTmpBuf++;
            dwTotalCount++;
         }
      }
      //
      // If all available entries were
      //  not enumerated, print the number actually 
      //  enumerated and the total number available.
      //
      if (dwEntriesRead < dwTotalEntries)
         fprintf(stderr, "\nTotal entries: %d", dwTotalEntries);
      //
      // Otherwise, just print the total.
      //
      printf("\nEntries enumerated: %d\n", dwTotalCount);
   }
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated buffer.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

   return 0;
}

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

各言語での呼び出し定義

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

DWORD NetUserGetGroups(
    LPCWSTR servername,   // optional
    LPCWSTR username,
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries
);

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

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetUserGetGroups(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> username 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
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

NetUserGetGroups = ctypes.windll.netapi32.NetUserGetGroups
NetUserGetGroups.restype = wintypes.DWORD
NetUserGetGroups.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # username : 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
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetUserGetGroups = Fiddle::Function.new(
  lib['NetUserGetGroups'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # username : 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_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetUserGetGroups(
        servername: *const u16,  // LPCWSTR optional
        username: *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
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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