ホーム › Storage.FileSystem › AllocReservedLog

AllocReservedLog

関数

CLFSマーシャリング領域にログ書き込み用の領域を予約する。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
pvMarshal	void*	inout	CreateLogMarshallingArea 関数を呼び出して割り当てられたマーシャリングコンテキストへのポインター。
cReservedRecords	DWORD	in	予約の調整に関連付けられた予約レコードの数。この値は 0 より大きい必要があります。
pcbAdjustment	LONGLONG*	inout	cReservedRecords で指定されたレコード数に関連付けられた、セクター境界に整列した予約領域のサイズ (バイト単位)。このパラメーターは、AlignReservedLog が *pcbAlignReservation に返す整列された予約サイズである必要があります。

名前

型

方向

説明

pvMarshal

void*

inout

CreateLogMarshallingArea 関数を呼び出して割り当てられたマーシャリングコンテキストへのポインター。

cReservedRecords

DWORD

予約の調整に関連付けられた予約レコードの数。

この値は 0 より大きい必要があります。

pcbAdjustment

LONGLONG*

inout

cReservedRecords で指定されたレコード数に関連付けられた、セクター境界に整列した予約領域のサイズ (バイト単位)。

このパラメーターは、AlignReservedLog が *pcbAlignReservation に返す整列された予約サイズである必要があります。

戻り値の型: BOOL

公式ドキュメント

予約レコードのセットに対して、セクター境界に整列した領域を割り当てます。

戻り値

関数が成功した場合、戻り値は 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 AllocReservedLog(
    void* pvMarshal,
    DWORD cReservedRecords,
    LONGLONG* pcbAdjustment
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AllocReservedLog(
    IntPtr pvMarshal,   // void* in/out
    uint cReservedRecords,   // DWORD
    ref long pcbAdjustment   // LONGLONG* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AllocReservedLog(
    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 AllocReservedLog 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

AllocReservedLog = ctypes.windll.clfsw32.AllocReservedLog
AllocReservedLog.restype = wintypes.BOOL
AllocReservedLog.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')
AllocReservedLog = Fiddle::Function.new(
  lib['AllocReservedLog'],
  [
    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 AllocReservedLog(
        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 AllocReservedLog(IntPtr pvMarshal, uint cReservedRecords, ref long pcbAdjustment);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_AllocReservedLog' -Namespace Win32 -PassThru
# $api::AllocReservedLog(pvMarshal, cReservedRecords, pcbAdjustment)

#uselib "clfsw32.dll"
#func global AllocReservedLog "AllocReservedLog" sptr, sptr, sptr
; AllocReservedLog 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 AllocReservedLog "AllocReservedLog" sptr, int, var
; res = AllocReservedLog(pvMarshal, cReservedRecords, pcbAdjustment)
; pvMarshal : void* in/out -> "sptr"
; cReservedRecords : DWORD -> "int"
; pcbAdjustment : LONGLONG* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global AllocReservedLog "AllocReservedLog" sptr, int, sptr
; res = AllocReservedLog(pvMarshal, cReservedRecords, varptr(pcbAdjustment))
; pvMarshal : void* in/out -> "sptr"
; cReservedRecords : DWORD -> "int"
; pcbAdjustment : LONGLONG* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。