Win32 API 日本語リファレンス
ホームStorage.FileSystem › InstallLogPolicy

InstallLogPolicy

関数
CLFSログに管理ポリシーをインストールする。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL InstallLogPolicy(
    HANDLE hLog,
    CLFS_MGMT_POLICY* pPolicy
);

パラメーター

名前方向説明
hLogHANDLEinログへのハンドル。
pPolicyCLFS_MGMT_POLICY*inoutインストールするポリシーを表す CLFS_MGMT_POLICY 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ログにポリシーをインストール(設定)します。

戻り値

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

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

解説(Remarks)

ログポリシーのインストールによって、動作が即座に変更されることはありません。

この関数を使用する例については、ログファイルの作成を参照してください。

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

各言語での呼び出し定義

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

BOOL InstallLogPolicy(
    HANDLE hLog,
    CLFS_MGMT_POLICY* pPolicy
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InstallLogPolicy(
    IntPtr hLog,   // HANDLE
    IntPtr pPolicy   // CLFS_MGMT_POLICY* in/out
);
<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InstallLogPolicy(
    hLog As IntPtr,   ' HANDLE
    pPolicy As IntPtr   ' CLFS_MGMT_POLICY* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hLog : HANDLE
' pPolicy : CLFS_MGMT_POLICY* in/out
Declare PtrSafe Function InstallLogPolicy Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal pPolicy As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InstallLogPolicy = ctypes.windll.clfsw32.InstallLogPolicy
InstallLogPolicy.restype = wintypes.BOOL
InstallLogPolicy.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_void_p,  # pPolicy : CLFS_MGMT_POLICY* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
InstallLogPolicy = Fiddle::Function.new(
  lib['InstallLogPolicy'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pPolicy : CLFS_MGMT_POLICY* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "clfsw32")]
extern "system" {
    fn InstallLogPolicy(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pPolicy: *mut CLFS_MGMT_POLICY  // CLFS_MGMT_POLICY* 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 InstallLogPolicy(IntPtr hLog, IntPtr pPolicy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_InstallLogPolicy' -Namespace Win32 -PassThru
# $api::InstallLogPolicy(hLog, pPolicy)
#uselib "clfsw32.dll"
#func global InstallLogPolicy "InstallLogPolicy" sptr, sptr
; InstallLogPolicy hLog, varptr(pPolicy)   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; pPolicy : CLFS_MGMT_POLICY* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "clfsw32.dll"
#cfunc global InstallLogPolicy "InstallLogPolicy" sptr, var
; res = InstallLogPolicy(hLog, pPolicy)
; hLog : HANDLE -> "sptr"
; pPolicy : CLFS_MGMT_POLICY* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL InstallLogPolicy(HANDLE hLog, CLFS_MGMT_POLICY* pPolicy)
#uselib "clfsw32.dll"
#cfunc global InstallLogPolicy "InstallLogPolicy" intptr, var
; res = InstallLogPolicy(hLog, pPolicy)
; hLog : HANDLE -> "intptr"
; pPolicy : CLFS_MGMT_POLICY* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procInstallLogPolicy = clfsw32.NewProc("InstallLogPolicy")
)

// hLog (HANDLE), pPolicy (CLFS_MGMT_POLICY* in/out)
r1, _, err := procInstallLogPolicy.Call(
	uintptr(hLog),
	uintptr(pPolicy),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InstallLogPolicy(
  hLog: THandle;   // HANDLE
  pPolicy: Pointer   // CLFS_MGMT_POLICY* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'InstallLogPolicy';
result := DllCall("clfsw32\InstallLogPolicy"
    , "Ptr", hLog   ; HANDLE
    , "Ptr", pPolicy   ; CLFS_MGMT_POLICY* in/out
    , "Int")   ; return: BOOL
●InstallLogPolicy(hLog, pPolicy) = DLL("clfsw32.dll", "bool InstallLogPolicy(void*, void*)")
# 呼び出し: InstallLogPolicy(hLog, pPolicy)
# hLog : HANDLE -> "void*"
# pPolicy : CLFS_MGMT_POLICY* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clfsw32" fn InstallLogPolicy(
    hLog: ?*anyopaque, // HANDLE
    pPolicy: [*c]CLFS_MGMT_POLICY // CLFS_MGMT_POLICY* in/out
) callconv(std.os.windows.WINAPI) i32;
proc InstallLogPolicy(
    hLog: pointer,  # HANDLE
    pPolicy: ptr CLFS_MGMT_POLICY  # CLFS_MGMT_POLICY* in/out
): int32 {.importc: "InstallLogPolicy", stdcall, dynlib: "clfsw32.dll".}
pragma(lib, "clfsw32");
extern(Windows)
int InstallLogPolicy(
    void* hLog,   // HANDLE
    CLFS_MGMT_POLICY* pPolicy   // CLFS_MGMT_POLICY* in/out
);
ccall((:InstallLogPolicy, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{CLFS_MGMT_POLICY}),
      hLog, pPolicy)
# hLog : HANDLE -> Ptr{Cvoid}
# pPolicy : CLFS_MGMT_POLICY* in/out -> Ptr{CLFS_MGMT_POLICY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InstallLogPolicy(
    void* hLog,
    void* pPolicy);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.InstallLogPolicy(hLog, pPolicy)
-- hLog : HANDLE
-- pPolicy : CLFS_MGMT_POLICY* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const InstallLogPolicy = lib.func('__stdcall', 'InstallLogPolicy', 'int32_t', ['void *', 'void *']);
// InstallLogPolicy(hLog, pPolicy)
// hLog : HANDLE -> 'void *'
// pPolicy : CLFS_MGMT_POLICY* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("clfsw32.dll", {
  InstallLogPolicy: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.InstallLogPolicy(hLog, pPolicy)
// hLog : HANDLE -> "pointer"
// pPolicy : CLFS_MGMT_POLICY* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InstallLogPolicy(
    void* hLog,
    void* pPolicy);
C, "clfsw32.dll");
// $ffi->InstallLogPolicy(hLog, pPolicy);
// hLog : HANDLE
// pPolicy : CLFS_MGMT_POLICY* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Clfsw32 extends StdCallLibrary {
    Clfsw32 INSTANCE = Native.load("clfsw32", Clfsw32.class);
    boolean InstallLogPolicy(
        Pointer hLog,   // HANDLE
        Pointer pPolicy   // CLFS_MGMT_POLICY* in/out
    );
}
@[Link("clfsw32")]
lib Libclfsw32
  fun InstallLogPolicy = InstallLogPolicy(
    hLog : Void*,   # HANDLE
    pPolicy : CLFS_MGMT_POLICY*   # CLFS_MGMT_POLICY* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InstallLogPolicyNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef InstallLogPolicyDart = int Function(Pointer<Void>, Pointer<Void>);
final InstallLogPolicy = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<InstallLogPolicyNative, InstallLogPolicyDart>('InstallLogPolicy');
// hLog : HANDLE -> Pointer<Void>
// pPolicy : CLFS_MGMT_POLICY* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InstallLogPolicy(
  hLog: THandle;   // HANDLE
  pPolicy: Pointer   // CLFS_MGMT_POLICY* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'InstallLogPolicy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InstallLogPolicy"
  c_InstallLogPolicy :: Ptr () -> Ptr () -> IO CInt
-- hLog : HANDLE -> Ptr ()
-- pPolicy : CLFS_MGMT_POLICY* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let installlogpolicy =
  foreign "InstallLogPolicy"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hLog : HANDLE -> (ptr void) *)
(* pPolicy : CLFS_MGMT_POLICY* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)

(cffi:defcfun ("InstallLogPolicy" install-log-policy :convention :stdcall) :int32
  (h-log :pointer)   ; HANDLE
  (p-policy :pointer))   ; CLFS_MGMT_POLICY* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InstallLogPolicy = Win32::API::More->new('clfsw32',
    'BOOL InstallLogPolicy(HANDLE hLog, LPVOID pPolicy)');
# my $ret = $InstallLogPolicy->Call($hLog, $pPolicy);
# hLog : HANDLE -> HANDLE
# pPolicy : CLFS_MGMT_POLICY* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型