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

FreeReservedLog

関数
CLFSマーシャリング領域で予約したログ領域を解放する。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL FreeReservedLog(
    void* pvMarshal,
    DWORD cReservedRecords,
    LONGLONG* pcbAdjustment
);

パラメーター

名前方向説明
pvMarshalvoid*inoutCreateLogMarshallingArea 関数を使用して割り当てられた、不透明なマーシャリングコンテキストへのポインターです。
cReservedRecordsDWORDin

解放する予約済みレコードの数です。

pcbAdjustment 内の調整のバイト数が正の場合、cReservedRecords は調整後に残る予約済みレコードの合計数です。それ以外の場合、このパラメーターは現在の予約済みレコード数から減算するレコードの数を指定しますが、予約済みの数を超えることはできません。

pcbAdjustmentLONGLONG*inout

調整によって影響を受ける予約領域のバイト数です。

入力時にこの数値が正の場合は、調整後に残る予約領域の合計サイズを指定します。このパラメーターが負の場合、その絶対値は解放するバイト数です。

この値は通常、次の関数の以前の呼び出しで返された実際の予約領域を集計したものです。

戻り値の型: BOOL

公式ドキュメント

ReserveAndAppendLog、ReserveAndAppendLogAligned、または AllocReservedLog の呼び出しによって作成されたマーシャリング領域内の予約済みログレコードの数を減らします。

戻り値

関数が成功した場合、戻り値は 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 FreeReservedLog(
    void* pvMarshal,
    DWORD cReservedRecords,
    LONGLONG* pcbAdjustment
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool FreeReservedLog(
    IntPtr pvMarshal,   // void* in/out
    uint cReservedRecords,   // DWORD
    ref long pcbAdjustment   // LONGLONG* in/out
);
<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FreeReservedLog(
    pvMarshal As IntPtr,   ' void* in/out
    cReservedRecords As UInteger,   ' DWORD
    ByRef pcbAdjustment As Long   ' LONGLONG* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pvMarshal : void* in/out
' cReservedRecords : DWORD
' pcbAdjustment : LONGLONG* in/out
Declare PtrSafe Function FreeReservedLog Lib "clfsw32" ( _
    ByVal pvMarshal As LongPtr, _
    ByVal cReservedRecords As Long, _
    ByRef pcbAdjustment As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FreeReservedLog = ctypes.windll.clfsw32.FreeReservedLog
FreeReservedLog.restype = wintypes.BOOL
FreeReservedLog.argtypes = [
    ctypes.POINTER(None),  # pvMarshal : void* in/out
    wintypes.DWORD,  # cReservedRecords : DWORD
    ctypes.POINTER(ctypes.c_longlong),  # pcbAdjustment : LONGLONG* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procFreeReservedLog = clfsw32.NewProc("FreeReservedLog")
)

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

extern "clfsw32" fn FreeReservedLog(
    pvMarshal: ?*anyopaque, // void* in/out
    cReservedRecords: u32, // DWORD
    pcbAdjustment: [*c]i64 // LONGLONG* in/out
) callconv(std.os.windows.WINAPI) i32;
proc FreeReservedLog(
    pvMarshal: pointer,  # void* in/out
    cReservedRecords: uint32,  # DWORD
    pcbAdjustment: ptr int64  # LONGLONG* in/out
): int32 {.importc: "FreeReservedLog", stdcall, dynlib: "clfsw32.dll".}
pragma(lib, "clfsw32");
extern(Windows)
int FreeReservedLog(
    void* pvMarshal,   // void* in/out
    uint cReservedRecords,   // DWORD
    long* pcbAdjustment   // LONGLONG* in/out
);
ccall((:FreeReservedLog, "clfsw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Int64}),
      pvMarshal, cReservedRecords, pcbAdjustment)
# pvMarshal : void* in/out -> Ptr{Cvoid}
# cReservedRecords : DWORD -> UInt32
# pcbAdjustment : LONGLONG* in/out -> Ptr{Int64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FreeReservedLog(
    void* pvMarshal,
    uint32_t cReservedRecords,
    int64_t* pcbAdjustment);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.FreeReservedLog(pvMarshal, cReservedRecords, pcbAdjustment)
-- pvMarshal : void* in/out
-- cReservedRecords : DWORD
-- pcbAdjustment : LONGLONG* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const FreeReservedLog = lib.func('__stdcall', 'FreeReservedLog', 'int32_t', ['void *', 'uint32_t', 'int64_t *']);
// FreeReservedLog(pvMarshal, cReservedRecords, pcbAdjustment)
// pvMarshal : void* in/out -> 'void *'
// cReservedRecords : DWORD -> 'uint32_t'
// pcbAdjustment : LONGLONG* in/out -> 'int64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("clfsw32.dll", {
  FreeReservedLog: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.FreeReservedLog(pvMarshal, cReservedRecords, pcbAdjustment)
// pvMarshal : void* in/out -> "pointer"
// cReservedRecords : DWORD -> "u32"
// pcbAdjustment : LONGLONG* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FreeReservedLog(
    void* pvMarshal,
    uint32_t cReservedRecords,
    int64_t* pcbAdjustment);
C, "clfsw32.dll");
// $ffi->FreeReservedLog(pvMarshal, cReservedRecords, pcbAdjustment);
// pvMarshal : void* in/out
// cReservedRecords : DWORD
// pcbAdjustment : LONGLONG* 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 FreeReservedLog(
        Pointer pvMarshal,   // void* in/out
        int cReservedRecords,   // DWORD
        LongByReference pcbAdjustment   // LONGLONG* in/out
    );
}
@[Link("clfsw32")]
lib Libclfsw32
  fun FreeReservedLog = FreeReservedLog(
    pvMarshal : Void*,   # void* in/out
    cReservedRecords : UInt32,   # DWORD
    pcbAdjustment : Int64*   # LONGLONG* 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 FreeReservedLogNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Int64>);
typedef FreeReservedLogDart = int Function(Pointer<Void>, int, Pointer<Int64>);
final FreeReservedLog = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<FreeReservedLogNative, FreeReservedLogDart>('FreeReservedLog');
// pvMarshal : void* in/out -> Pointer<Void>
// cReservedRecords : DWORD -> Uint32
// pcbAdjustment : LONGLONG* in/out -> Pointer<Int64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FreeReservedLog(
  pvMarshal: Pointer;   // void* in/out
  cReservedRecords: DWORD;   // DWORD
  pcbAdjustment: Pointer   // LONGLONG* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'FreeReservedLog';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FreeReservedLog"
  c_FreeReservedLog :: Ptr () -> Word32 -> Ptr Int64 -> IO CInt
-- pvMarshal : void* in/out -> Ptr ()
-- cReservedRecords : DWORD -> Word32
-- pcbAdjustment : LONGLONG* in/out -> Ptr Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let freereservedlog =
  foreign "FreeReservedLog"
    ((ptr void) @-> uint32_t @-> (ptr int64_t) @-> returning int32_t)
(* pvMarshal : void* in/out -> (ptr void) *)
(* cReservedRecords : DWORD -> uint32_t *)
(* pcbAdjustment : LONGLONG* in/out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)

(cffi:defcfun ("FreeReservedLog" free-reserved-log :convention :stdcall) :int32
  (pv-marshal :pointer)   ; void* in/out
  (c-reserved-records :uint32)   ; DWORD
  (pcb-adjustment :pointer))   ; LONGLONG* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FreeReservedLog = Win32::API::More->new('clfsw32',
    'BOOL FreeReservedLog(LPVOID pvMarshal, DWORD cReservedRecords, LPVOID pcbAdjustment)');
# my $ret = $FreeReservedLog->Call($pvMarshal, $cReservedRecords, $pcbAdjustment);
# pvMarshal : void* in/out -> LPVOID
# cReservedRecords : DWORD -> DWORD
# pcbAdjustment : LONGLONG* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。