ホーム › Storage.FileSystem › SetLogArchiveTail

SetLogArchiveTail

関数

CLFSログのアーカイブ末尾LSNを設定する。

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

シグネチャ

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

BOOL SetLogArchiveTail(
    HANDLE hLog,
    CLS_LSN* plsnArchiveTail,
    void* pReserved
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	CreateLogFile から取得したログのハンドルです。このログハンドルは、専用ログまたは多重化ログのいずれかを参照できます。
plsnArchiveTail	CLS_LSN*	inout	ログ内の有効な物理 LSN を指定する CLFS_LSN 構造体へのポインターです。 Note 物理ログまたはログストリームのいずれのハンドルに対しても、plsnArchiveTail は物理ログ内のレコードアドレスを参照するため、物理 LSN となります。
pReserved	void*	inout	このパラメーターは予約されており、NULL を設定してください。

名前

型

方向

説明

hLog

HANDLE

CreateLogFile から取得したログのハンドルです。

このログハンドルは、専用ログまたは多重化ログのいずれかを参照できます。

plsnArchiveTail

CLS_LSN*

inout

ログ内の有効な物理 LSN を指定する CLFS_LSN 構造体へのポインターです。

Note 物理ログまたはログストリームのいずれのハンドルに対しても、plsnArchiveTail は物理ログ内のレコードアドレスを参照するため、物理 LSN となります。

pReserved

void*

inout

このパラメーターは予約されており、NULL を設定してください。

戻り値の型: BOOL

公式ドキュメント

アーカイブ可能なログの、最後にアーカイブされたログシーケンス番号 (LSN)、すなわちアーカイブテールを設定します。

戻り値

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

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

次の一覧に、発生し得るエラーコードを示します。

解説(Remarks)

PrepareLogArchive から取得したアーカイブコンテキストのうち、TerminateLogArchive で終了されていないものがある場合、すべてのアーカイブが完了するまで変更は反映されません。未完了のアーカイブコンテキストが存在する間は、最も大きいアーカイブテールのみが適用されます。

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

各言語での呼び出し定義

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

BOOL SetLogArchiveTail(
    HANDLE hLog,
    CLS_LSN* plsnArchiveTail,
    void* pReserved
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetLogArchiveTail(
    IntPtr hLog,   // HANDLE
    IntPtr plsnArchiveTail,   // CLS_LSN* in/out
    IntPtr pReserved   // void* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetLogArchiveTail(
    hLog As IntPtr,   ' HANDLE
    plsnArchiveTail As IntPtr,   ' CLS_LSN* in/out
    pReserved As IntPtr   ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' plsnArchiveTail : CLS_LSN* in/out
' pReserved : void* in/out
Declare PtrSafe Function SetLogArchiveTail Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal plsnArchiveTail As LongPtr, _
    ByVal pReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetLogArchiveTail = ctypes.windll.clfsw32.SetLogArchiveTail
SetLogArchiveTail.restype = wintypes.BOOL
SetLogArchiveTail.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_void_p,  # plsnArchiveTail : CLS_LSN* in/out
    ctypes.POINTER(None),  # pReserved : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
SetLogArchiveTail = Fiddle::Function.new(
  lib['SetLogArchiveTail'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # plsnArchiveTail : CLS_LSN* in/out
    Fiddle::TYPE_VOIDP,  # pReserved : void* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn SetLogArchiveTail(
        hLog: *mut core::ffi::c_void,  // HANDLE
        plsnArchiveTail: *mut CLS_LSN,  // CLS_LSN* in/out
        pReserved: *mut ()  // void* 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 SetLogArchiveTail(IntPtr hLog, IntPtr plsnArchiveTail, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_SetLogArchiveTail' -Namespace Win32 -PassThru
# $api::SetLogArchiveTail(hLog, plsnArchiveTail, pReserved)

#uselib "clfsw32.dll"
#func global SetLogArchiveTail "SetLogArchiveTail" sptr, sptr, sptr
; SetLogArchiveTail hLog, varptr(plsnArchiveTail), pReserved   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; plsnArchiveTail : CLS_LSN* in/out -> "sptr"
; pReserved : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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