GetGPOListW

関数

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

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

シグネチャ

// USERENV.dll  (Unicode / -W)
#include <windows.h>

BOOL GetGPOListW(
    HANDLE hToken,   // optional
    LPCWSTR lpName,   // optional
    LPCWSTR lpHostName,   // optional
    LPCWSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTW** pGPOList
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 ヘッダーは GetGPOList を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USERENV.dll  (Unicode / -W)
#include <windows.h>

BOOL GetGPOListW(
    HANDLE hToken,   // optional
    LPCWSTR lpName,   // optional
    LPCWSTR lpHostName,   // optional
    LPCWSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTW** pGPOList
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetGPOListW(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpHostName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpComputerName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    IntPtr pGPOList   // GROUP_POLICY_OBJECTW** out
);

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

' hToken : HANDLE optional
' lpName : LPCWSTR optional
' lpHostName : LPCWSTR optional
' lpComputerName : LPCWSTR optional
' dwFlags : DWORD
' pGPOList : GROUP_POLICY_OBJECTW** out
Declare PtrSafe Function GetGPOListW Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpName As LongPtr, _
    ByVal lpHostName As LongPtr, _
    ByVal lpComputerName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pGPOList As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetGPOListW = Fiddle::Function.new(
  lib['GetGPOListW'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpHostName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpComputerName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pGPOList : GROUP_POLICY_OBJECTW** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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