GetGPOListA

関数

適用されるGPOの一覧を取得する(ANSI版)。

DLLUSERENV.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// USERENV.dll  (ANSI / -A)
#include <windows.h>

BOOL GetGPOListA(
    HANDLE hToken,   // optional
    LPCSTR lpName,   // optional
    LPCSTR lpHostName,   // optional
    LPCSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTA** pGPOList
);

パラメーター

名前	型	方向	説明
hToken	HANDLE	inoptional	LogonUser、 CreateRestrictedToken、 DuplicateToken、 OpenProcessToken、または OpenThreadToken 関数から返された、ユーザーまたはコンピューターのトークン。このトークンには TOKEN_IMPERSONATE および TOKEN_QUERY のアクセス権が必要です。詳細については、アクセストークンオブジェクトのアクセス権および後述の「解説」セクションを参照してください。このパラメーターが NULL の場合は、lpName パラメーターと lpHostName パラメーターに値を指定する必要があります。
lpName	LPCSTR	inoptional	完全修飾識別名形式のユーザー名またはコンピューター名へのポインター (例: "CN=user, OU=users, DC=contoso, DC=com")。 hToken パラメーターが NULL でない場合、このパラメーターは NULL でなければなりません。
lpHostName	LPCSTR	inoptional	DNS ドメイン名 (推奨) またはドメインコントローラー名。ドメインコントローラー名は、 DsGetDcName 関数の flags パラメーターに DS_DIRECTORY_SERVICE_REQUIRED を指定して取得できます。 hToken パラメーターが NULL でない場合、このパラメーターは NULL でなければなりません。
lpComputerName	LPCSTR	inoptional	サイトの位置を判別するために使用するコンピューター名へのポインター。名前の形式は "\\computer_name" です。このパラメーターが NULL の場合は、ローカルコンピューター名が使用されます。
dwFlags	DWORD	in	情報の取得方法を制御するために使用する追加フラグを指定する値。GPO_LIST_FLAG_MACHINE を指定すると、関数はコンピューターのポリシー情報を取得します。GPO_LIST_FLAG_MACHINE を指定しない場合、関数はユーザーのポリシー情報を取得します。 GPO_LIST_FLAG_SITEONLY を指定すると、関数はコンピューターまたはユーザーのサイト情報のみを返します。
pGPOList	GROUP_POLICY_OBJECTA**	out	GPO 構造体の一覧を受け取るポインター。詳細については、 GROUP_POLICY_OBJECT を参照してください。

戻り値の型: BOOL

公式ドキュメント

GetGPOList 関数は、指定したユーザーまたはコンピューターの GPO の一覧を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

GetGPOList 関数は、ユーザーまたはコンピューターの代理として動作するサービスでの使用を想定しています。サービスはこの関数を呼び出して GPO の一覧を取得し、各 GPO についてサービス固有のポリシーを確認します。

トークンを指定してこの関数を呼び出すと、最も正確な一覧が得られます。システムはユーザーまたはコンピューターに対するアクセスチェックを実行できます。ユーザー名またはコンピューター名とドメインコントローラー名を指定して呼び出す方が、トークンを指定して呼び出すよりも高速です。ただし、トークンを指定しない場合、システムは呼び出し元のセキュリティアクセスを使用するため、対象のユーザーまたはコンピューターにとって一覧が完全に正しいとは限りません。

GetGPOList の呼び出し時にコンピューターの最も正確な GPO の一覧を取得するには、呼び出し元がそのコンピューターのドメイン内のすべての OU とサイトに対する読み取りアクセス権を持ち、さらに、そのドメインのサイト、ドメイン、または OU にリンクされているすべての GPO に対する読み取りおよびグループポリシーの適用のアクセス権を持っている必要があります。呼び出し元の例としては、lpName パラメーターで指定された名前のコンピューター上で実行されているサービスが挙げられます。GPO の一覧を取得する別の方法として、RsopPlanningModeProvider WMI クラスの RsopCreateSession メソッドを呼び出す方法があります。このメソッドは、仮想的なシナリオにおけるコンピューターまたはユーザーアカウントのポリシーの結果セットデータを生成できます。

GPO の一覧の処理が完了したら、 FreeGPOList 関数を呼び出して一覧を解放します。

一般に、ユーザーの GPO の一覧を取得する場合は、次のコード例のようにトークンを指定して GetGPOList を呼び出してください。

LPGROUP_POLICY_OBJECT  pGPOList;
      if (GetGPOList (hToken, NULL, NULL, NULL, 0, &pGPOList))
      {
//        ここで処理を実行します。
//
//        処理が完了したら GPO の一覧を解放します。
          FreeGPOList (pGPOList);
      }

通常、コンピューターの GPO の一覧を取得するには、次のコードスニペットのようにコンピューター名とドメインコントローラー名を指定して GetGPOList を呼び出します。

LPGROUP_POLICY_OBJECT  pGPOList;
      if (GetGPOList (NULL, lpMachineName, lpHostName, lpMachineName, GPO_LIST_FLAG_MACHINE, &pGPOList))
      {
//        ここで処理を実行します。
//
//        処理が完了したら GPO の一覧を解放します。
          FreeGPOList (pGPOList);
      }

特定のユーザーまたはコンピューターと拡張機能に適用されている GPO の一覧を取得するには、 GetAppliedGPOList 関数を呼び出します。

メモ

userenv.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetGPOList を定義しています。エンコード中立のエイリアスと、エンコード中立でないコードを混在させると不整合が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// USERENV.dll  (ANSI / -A)
#include <windows.h>

BOOL GetGPOListA(
    HANDLE hToken,   // optional
    LPCSTR lpName,   // optional
    LPCSTR lpHostName,   // optional
    LPCSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTA** pGPOList
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetGPOListA(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpHostName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpComputerName,   // LPCSTR optional
    uint dwFlags,   // DWORD
    IntPtr pGPOList   // GROUP_POLICY_OBJECTA** out
);

<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetGPOListA(
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> lpName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpHostName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpComputerName As String,   ' LPCSTR optional
    dwFlags As UInteger,   ' DWORD
    pGPOList As IntPtr   ' GROUP_POLICY_OBJECTA** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hToken : HANDLE optional
' lpName : LPCSTR optional
' lpHostName : LPCSTR optional
' lpComputerName : LPCSTR optional
' dwFlags : DWORD
' pGPOList : GROUP_POLICY_OBJECTA** out
Declare PtrSafe Function GetGPOListA Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpName As String, _
    ByVal lpHostName As String, _
    ByVal lpComputerName As String, _
    ByVal dwFlags As Long, _
    ByVal pGPOList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetGPOListA = ctypes.windll.userenv.GetGPOListA
GetGPOListA.restype = wintypes.BOOL
GetGPOListA.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.LPCSTR,  # lpName : LPCSTR optional
    wintypes.LPCSTR,  # lpHostName : LPCSTR optional
    wintypes.LPCSTR,  # lpComputerName : LPCSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pGPOList : GROUP_POLICY_OBJECTA** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetGPOListA = Fiddle::Function.new(
  lib['GetGPOListA'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpHostName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpComputerName : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pGPOList : GROUP_POLICY_OBJECTA** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "userenv")]
extern "system" {
    fn GetGPOListA(
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        lpName: *const u8,  // LPCSTR optional
        lpHostName: *const u8,  // LPCSTR optional
        lpComputerName: *const u8,  // LPCSTR optional
        dwFlags: u32,  // DWORD
        pGPOList: *mut *mut GROUP_POLICY_OBJECTA  // GROUP_POLICY_OBJECTA** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetGPOListA(IntPtr hToken, [MarshalAs(UnmanagedType.LPStr)] string lpName, [MarshalAs(UnmanagedType.LPStr)] string lpHostName, [MarshalAs(UnmanagedType.LPStr)] string lpComputerName, uint dwFlags, IntPtr pGPOList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetGPOListA' -Namespace Win32 -PassThru
# $api::GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)

#uselib "USERENV.dll"
#func global GetGPOListA "GetGPOListA" sptr, sptr, sptr, sptr, sptr, sptr
; GetGPOListA hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(pGPOList)   ; 戻り値は stat
; hToken : HANDLE optional -> "sptr"
; lpName : LPCSTR optional -> "sptr"
; lpHostName : LPCSTR optional -> "sptr"
; lpComputerName : LPCSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pGPOList : GROUP_POLICY_OBJECTA** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USERENV.dll"
#cfunc global GetGPOListA "GetGPOListA" sptr, str, str, str, int, var
; res = GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
; hToken : HANDLE optional -> "sptr"
; lpName : LPCSTR optional -> "str"
; lpHostName : LPCSTR optional -> "str"
; lpComputerName : LPCSTR optional -> "str"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USERENV.dll"
#cfunc global GetGPOListA "GetGPOListA" sptr, str, str, str, int, sptr
; res = GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(pGPOList))
; hToken : HANDLE optional -> "sptr"
; lpName : LPCSTR optional -> "str"
; lpHostName : LPCSTR optional -> "str"
; lpComputerName : LPCSTR optional -> "str"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTA** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。