ホーム › Storage.FileSystem › AlignReservedLog

AlignReservedLog

関数

CLFSログの予約領域に必要なアラインメント済みバイト数を算出する。

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

シグネチャ

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

BOOL AlignReservedLog(
    void* pvMarshal,
    DWORD cReservedRecords,
    LONGLONG* rgcbReservation,
    LONGLONG* pcbAlignReservation
);

パラメーター

名前	型	方向	説明
pvMarshal	void*	inout	CreateLogMarshallingArea 関数を呼び出して割り当てられた、不透明なマーシャリングコンテキストへのポインターです。
cReservedRecords	DWORD	in	予約調整に関連付けられた予約レコードの数です。
rgcbReservation	LONGLONG*	inout	現在のマーシャリングコンテキストに関連付けられたログ内に予約する領域割り当ての配列で、バイト単位で指定します。割り当ての数は、cReservedRecords で指定されるレコードの数に対応します。各割り当ては 0 より大きい値でなければなりません。そうでない場合、関数は ERROR_INVALID_PARAMETER で失敗します。
pcbAlignReservation	LONGLONG*	inout	cRecords で指定されるレコードの数と rgcbReservation 配列で指定される予約サイズが与えられたうえで、ログ内に予約するセクターアラインメントされたバイト領域の数を関数が返す変数へのポインターです。 pcbAlignReservation に返される値は、AllocReservedLog への入力として使用されます。AllocReservedLog* が成功した場合、この値は常に 0 より大きくなります。AllocReservedLog が失敗した場合、値は 0 になります。

戻り値の型: 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 AlignReservedLog(
    void* pvMarshal,
    DWORD cReservedRecords,
    LONGLONG* rgcbReservation,
    LONGLONG* pcbAlignReservation
);

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

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AlignReservedLog(
    pvMarshal As IntPtr,   ' void* in/out
    cReservedRecords As UInteger,   ' DWORD
    ByRef rgcbReservation As Long,   ' LONGLONG* in/out
    ByRef pcbAlignReservation As Long   ' LONGLONG* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvMarshal : void* in/out
' cReservedRecords : DWORD
' rgcbReservation : LONGLONG* in/out
' pcbAlignReservation : LONGLONG* in/out
Declare PtrSafe Function AlignReservedLog Lib "clfsw32" ( _
    ByVal pvMarshal As LongPtr, _
    ByVal cReservedRecords As Long, _
    ByRef rgcbReservation As LongLong, _
    ByRef pcbAlignReservation As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AlignReservedLog = ctypes.windll.clfsw32.AlignReservedLog
AlignReservedLog.restype = wintypes.BOOL
AlignReservedLog.argtypes = [
    ctypes.POINTER(None),  # pvMarshal : void* in/out
    wintypes.DWORD,  # cReservedRecords : DWORD
    ctypes.POINTER(ctypes.c_longlong),  # rgcbReservation : LONGLONG* in/out
    ctypes.POINTER(ctypes.c_longlong),  # pcbAlignReservation : LONGLONG* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
AlignReservedLog = Fiddle::Function.new(
  lib['AlignReservedLog'],
  [
    Fiddle::TYPE_VOIDP,  # pvMarshal : void* in/out
    -Fiddle::TYPE_INT,  # cReservedRecords : DWORD
    Fiddle::TYPE_VOIDP,  # rgcbReservation : LONGLONG* in/out
    Fiddle::TYPE_VOIDP,  # pcbAlignReservation : LONGLONG* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn AlignReservedLog(
        pvMarshal: *mut (),  // void* in/out
        cReservedRecords: u32,  // DWORD
        rgcbReservation: *mut i64,  // LONGLONG* in/out
        pcbAlignReservation: *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 AlignReservedLog(IntPtr pvMarshal, uint cReservedRecords, ref long rgcbReservation, ref long pcbAlignReservation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_AlignReservedLog' -Namespace Win32 -PassThru
# $api::AlignReservedLog(pvMarshal, cReservedRecords, rgcbReservation, pcbAlignReservation)

#uselib "clfsw32.dll"
#func global AlignReservedLog "AlignReservedLog" sptr, sptr, sptr, sptr
; AlignReservedLog pvMarshal, cReservedRecords, varptr(rgcbReservation), varptr(pcbAlignReservation)   ; 戻り値は stat
; pvMarshal : void* in/out -> "sptr"
; cReservedRecords : DWORD -> "sptr"
; rgcbReservation : LONGLONG* in/out -> "sptr"
; pcbAlignReservation : LONGLONG* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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