ホーム › Storage.FileSystem › QueryLogPolicy

QueryLogPolicy

関数

CLFSログに設定された管理ポリシーを照会する。

DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL QueryLogPolicy(
    HANDLE hLog,
    CLFS_MGMT_POLICY_TYPE ePolicyType,
    CLFS_MGMT_POLICY* pPolicyBuffer,
    DWORD* pcbPolicyBuffer
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	クエリ対象のログのハンドル。
ePolicyType	CLFS_MGMT_POLICY_TYPE	in	クエリするポリシーの種類を指定します。ポリシーの種類は CLFS_MGMT_POLICY_TYPE に列挙されています。
pPolicyBuffer	CLFS_MGMT_POLICY*	inout	返されるポリシーを受け取るバッファーへのポインター。
pcbPolicyBuffer	DWORD*	inout	pPolicyBuffer のサイズへのポインター。バッファーが十分に大きくない場合、pcbPolicyBuffer は指定したポリシーを正常に取得するために必要なバッファーのサイズを受け取ります。

戻り値の型: BOOL

公式ドキュメント

QueryLogPolicy 関数を使用すると、指定したログに対してインストールされているポリシーを取得できます。

戻り値

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

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

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

各言語での呼び出し定義

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

BOOL QueryLogPolicy(
    HANDLE hLog,
    CLFS_MGMT_POLICY_TYPE ePolicyType,
    CLFS_MGMT_POLICY* pPolicyBuffer,
    DWORD* pcbPolicyBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueryLogPolicy(
    IntPtr hLog,   // HANDLE
    int ePolicyType,   // CLFS_MGMT_POLICY_TYPE
    IntPtr pPolicyBuffer,   // CLFS_MGMT_POLICY* in/out
    ref uint pcbPolicyBuffer   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryLogPolicy(
    hLog As IntPtr,   ' HANDLE
    ePolicyType As Integer,   ' CLFS_MGMT_POLICY_TYPE
    pPolicyBuffer As IntPtr,   ' CLFS_MGMT_POLICY* in/out
    ByRef pcbPolicyBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' ePolicyType : CLFS_MGMT_POLICY_TYPE
' pPolicyBuffer : CLFS_MGMT_POLICY* in/out
' pcbPolicyBuffer : DWORD* in/out
Declare PtrSafe Function QueryLogPolicy Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal ePolicyType As Long, _
    ByVal pPolicyBuffer As LongPtr, _
    ByRef pcbPolicyBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QueryLogPolicy = ctypes.windll.clfsw32.QueryLogPolicy
QueryLogPolicy.restype = wintypes.BOOL
QueryLogPolicy.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_int,  # ePolicyType : CLFS_MGMT_POLICY_TYPE
    ctypes.c_void_p,  # pPolicyBuffer : CLFS_MGMT_POLICY* in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbPolicyBuffer : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
QueryLogPolicy = Fiddle::Function.new(
  lib['QueryLogPolicy'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_INT,  # ePolicyType : CLFS_MGMT_POLICY_TYPE
    Fiddle::TYPE_VOIDP,  # pPolicyBuffer : CLFS_MGMT_POLICY* in/out
    Fiddle::TYPE_VOIDP,  # pcbPolicyBuffer : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn QueryLogPolicy(
        hLog: *mut core::ffi::c_void,  // HANDLE
        ePolicyType: i32,  // CLFS_MGMT_POLICY_TYPE
        pPolicyBuffer: *mut CLFS_MGMT_POLICY,  // CLFS_MGMT_POLICY* in/out
        pcbPolicyBuffer: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true)]
public static extern bool QueryLogPolicy(IntPtr hLog, int ePolicyType, IntPtr pPolicyBuffer, ref uint pcbPolicyBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_QueryLogPolicy' -Namespace Win32 -PassThru
# $api::QueryLogPolicy(hLog, ePolicyType, pPolicyBuffer, pcbPolicyBuffer)

#uselib "clfsw32.dll"
#func global QueryLogPolicy "QueryLogPolicy" sptr, sptr, sptr, sptr
; QueryLogPolicy hLog, ePolicyType, varptr(pPolicyBuffer), varptr(pcbPolicyBuffer)   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; ePolicyType : CLFS_MGMT_POLICY_TYPE -> "sptr"
; pPolicyBuffer : CLFS_MGMT_POLICY* in/out -> "sptr"
; pcbPolicyBuffer : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global QueryLogPolicy "QueryLogPolicy" sptr, int, var, var
; res = QueryLogPolicy(hLog, ePolicyType, pPolicyBuffer, pcbPolicyBuffer)
; hLog : HANDLE -> "sptr"
; ePolicyType : CLFS_MGMT_POLICY_TYPE -> "int"
; pPolicyBuffer : CLFS_MGMT_POLICY* in/out -> "var"
; pcbPolicyBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global QueryLogPolicy "QueryLogPolicy" sptr, int, sptr, sptr
; res = QueryLogPolicy(hLog, ePolicyType, varptr(pPolicyBuffer), varptr(pcbPolicyBuffer))
; hLog : HANDLE -> "sptr"
; ePolicyType : CLFS_MGMT_POLICY_TYPE -> "int"
; pPolicyBuffer : CLFS_MGMT_POLICY* in/out -> "sptr"
; pcbPolicyBuffer : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。