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

SetLogFileSizeWithPolicy

関数
ポリシーに従いCLFSログファイルのサイズを設定する。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetLogFileSizeWithPolicy(
    HANDLE hLog,
    ULONGLONG* pDesiredSize,
    ULONGLONG* pResultingSize
);

パラメーター

名前方向説明
hLogHANDLEinログへのハンドル。
pDesiredSizeULONGLONG*in

要求するログのサイズを指定する値へのポインター。次のいずれかの値で表します。実際の結果サイズについては、pResultingSize パラメーターを参照してください。

意味
0
最小サイズポリシーを適用します。

最小サイズポリシーがインストールされていない場合は、次のいずれかが発生します。

  • ログのコンテナー数が 2 未満の場合、ログは 2 コンテナーのサイズに拡張されます。
  • ログのコンテナー数が 2 以上の場合、変更は行われず、関数呼び出しは成功します。

最小サイズポリシーがインストールされている場合は、次のいずれかが発生します。

  • ログのコンテナー数が最小サイズポリシーで指定された最小コンテナー数未満の場合、ログはポリシーで指定された最小コンテナー数まで拡張されます。
  • ログのコンテナー数が最小サイズポリシーで指定された最小コンテナー数以上の場合、変更は行われず、関数呼び出しはエラーなしで成功します。

詳細については、InstallLogPolicy を参照してください。

1
有効な値ではありません。関数呼び出しは ERROR_INVALID_PARAMETER で失敗します。
2–1023
コンテナー数で表した、要求するログのサイズ。

この数値がインストールされているポリシーで指定された最小コンテナー数より小さい場合、関数呼び出しは ERROR_COULD_NOT_RESIZE_LOG で失敗します。

この数値がインストールされているポリシーで指定された最大コンテナー数より大きい場合、ログはポリシーで指定された最大コンテナー数までのみ拡張され、関数はエラーなしで成功します。

1024–MAXULONGLONG
最大サイズポリシーがインストールされていない場合、関数呼び出しは ERROR_LOG_POLICY_CONFLICT で失敗します。

最大サイズポリシーがインストールされている場合、ログは最大サイズポリシーで指定された最大コンテナー数まで拡張され、関数はエラーなしで成功します。

pResultingSizeULONGLONG*out有効な ULONGLONG データ変数へのポインター。成功時にサイズ変更後のログのコンテナー数を受け取ります。

戻り値の型: BOOL

公式ドキュメント

インストールされているポリシーの状態に基づいて、ログにコンテナーを追加または削除します。

戻り値

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

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

解説(Remarks)

コンテナーは .blf ファイルと同じセキュリティ属性を使用して作成され、.blf ファイルの所有者のコンテキストではなく、アプリケーションのコンテキスト内で作成されます。.blf ファイルの詳細については、Log Types を参照してください。コンテナーが削除される場合、呼び出し元アプリケーションのセキュリティコンテキストを使用して削除されます。

この関数を使用する例については、Creating a Log File を参照してください。

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

各言語での呼び出し定義

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

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

SetLogFileSizeWithPolicy = ctypes.windll.clfsw32.SetLogFileSizeWithPolicy
SetLogFileSizeWithPolicy.restype = wintypes.BOOL
SetLogFileSizeWithPolicy.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.POINTER(ctypes.c_ulonglong),  # pDesiredSize : ULONGLONG*
    ctypes.POINTER(ctypes.c_ulonglong),  # pResultingSize : ULONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procSetLogFileSizeWithPolicy = clfsw32.NewProc("SetLogFileSizeWithPolicy")
)

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

extern "clfsw32" fn SetLogFileSizeWithPolicy(
    hLog: ?*anyopaque, // HANDLE
    pDesiredSize: [*c]u64, // ULONGLONG*
    pResultingSize: [*c]u64 // ULONGLONG* out
) callconv(std.os.windows.WINAPI) i32;
proc SetLogFileSizeWithPolicy(
    hLog: pointer,  # HANDLE
    pDesiredSize: ptr uint64,  # ULONGLONG*
    pResultingSize: ptr uint64  # ULONGLONG* out
): int32 {.importc: "SetLogFileSizeWithPolicy", stdcall, dynlib: "clfsw32.dll".}
pragma(lib, "clfsw32");
extern(Windows)
int SetLogFileSizeWithPolicy(
    void* hLog,   // HANDLE
    ulong* pDesiredSize,   // ULONGLONG*
    ulong* pResultingSize   // ULONGLONG* out
);
ccall((:SetLogFileSizeWithPolicy, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt64}, Ptr{UInt64}),
      hLog, pDesiredSize, pResultingSize)
# hLog : HANDLE -> Ptr{Cvoid}
# pDesiredSize : ULONGLONG* -> Ptr{UInt64}
# pResultingSize : ULONGLONG* out -> Ptr{UInt64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetLogFileSizeWithPolicy(
    void* hLog,
    uint64_t* pDesiredSize,
    uint64_t* pResultingSize);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.SetLogFileSizeWithPolicy(hLog, pDesiredSize, pResultingSize)
-- hLog : HANDLE
-- pDesiredSize : ULONGLONG*
-- pResultingSize : ULONGLONG* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const SetLogFileSizeWithPolicy = lib.func('__stdcall', 'SetLogFileSizeWithPolicy', 'int32_t', ['void *', 'uint64_t *', 'uint64_t *']);
// SetLogFileSizeWithPolicy(hLog, pDesiredSize, pResultingSize)
// hLog : HANDLE -> 'void *'
// pDesiredSize : ULONGLONG* -> 'uint64_t *'
// pResultingSize : ULONGLONG* out -> 'uint64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("clfsw32.dll", {
  SetLogFileSizeWithPolicy: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetLogFileSizeWithPolicy(hLog, pDesiredSize, pResultingSize)
// hLog : HANDLE -> "pointer"
// pDesiredSize : ULONGLONG* -> "pointer"
// pResultingSize : ULONGLONG* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetLogFileSizeWithPolicy(
    void* hLog,
    uint64_t* pDesiredSize,
    uint64_t* pResultingSize);
C, "clfsw32.dll");
// $ffi->SetLogFileSizeWithPolicy(hLog, pDesiredSize, pResultingSize);
// hLog : HANDLE
// pDesiredSize : ULONGLONG*
// pResultingSize : ULONGLONG* 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 SetLogFileSizeWithPolicy(
        Pointer hLog,   // HANDLE
        LongByReference pDesiredSize,   // ULONGLONG*
        LongByReference pResultingSize   // ULONGLONG* out
    );
}
@[Link("clfsw32")]
lib Libclfsw32
  fun SetLogFileSizeWithPolicy = SetLogFileSizeWithPolicy(
    hLog : Void*,   # HANDLE
    pDesiredSize : UInt64*,   # ULONGLONG*
    pResultingSize : UInt64*   # ULONGLONG* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

foreign import stdcall safe "SetLogFileSizeWithPolicy"
  c_SetLogFileSizeWithPolicy :: Ptr () -> Ptr Word64 -> Ptr Word64 -> IO CInt
-- hLog : HANDLE -> Ptr ()
-- pDesiredSize : ULONGLONG* -> Ptr Word64
-- pResultingSize : ULONGLONG* out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

公式の関連項目