ホーム › Storage.FileSystem › GetNextLogArchiveExtent

GetNextLogArchiveExtent

関数

CLFSログアーカイブの次のエクステント記述子を取得する。

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

シグネチャ

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

BOOL GetNextLogArchiveExtent(
    void* pvArchiveContext,
    CLS_ARCHIVE_DESCRIPTOR* rgadExtent,
    DWORD cDescriptors,
    DWORD* pcDescriptorsReturned
);

パラメーター

名前	型	方向	説明
pvArchiveContext	void*	inout	PrepareLogArchive の呼び出しによって取得されるアーカイブコンテキストへのポインターです。このコンテキストはカーソルの状態を保持しており、アーカイブ内のファイルエクステントのセットを反復処理できるようにします。アーカイブクライアントは、TerminateLogArchive 関数を使用してこのコンテキストの割り当てを解放する責任があります。
rgadExtent	CLS_ARCHIVE_DESCRIPTOR*	inout	この関数によって設定される、クライアントが割り当てた CLFS_ARCHIVE_DESCRIPTOR 構造体の配列です。
cDescriptors	DWORD	in	rgadExtent 配列の要素数です。この値は、この関数によって取得できるアーカイブ記述子の最大数です。
pcDescriptorsReturned	DWORD*	inout	この関数によって設定された rgadExtent 配列内の記述子の数です。この値が cDescriptors より小さい場合、記述子のセットは尽きており、アーカイブクライアントは順序付けられた記述子セットの反復処理を終了できます。この関数をさらに呼び出すと、ERROR_NO_MORE_ENTRIES で失敗します。

戻り値の型: 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 GetNextLogArchiveExtent(
    void* pvArchiveContext,
    CLS_ARCHIVE_DESCRIPTOR* rgadExtent,
    DWORD cDescriptors,
    DWORD* pcDescriptorsReturned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNextLogArchiveExtent(
    IntPtr pvArchiveContext,   // void* in/out
    IntPtr rgadExtent,   // CLS_ARCHIVE_DESCRIPTOR* in/out
    uint cDescriptors,   // DWORD
    ref uint pcDescriptorsReturned   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNextLogArchiveExtent(
    pvArchiveContext As IntPtr,   ' void* in/out
    rgadExtent As IntPtr,   ' CLS_ARCHIVE_DESCRIPTOR* in/out
    cDescriptors As UInteger,   ' DWORD
    ByRef pcDescriptorsReturned As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pvArchiveContext : void* in/out
' rgadExtent : CLS_ARCHIVE_DESCRIPTOR* in/out
' cDescriptors : DWORD
' pcDescriptorsReturned : DWORD* in/out
Declare PtrSafe Function GetNextLogArchiveExtent Lib "clfsw32" ( _
    ByVal pvArchiveContext As LongPtr, _
    ByVal rgadExtent As LongPtr, _
    ByVal cDescriptors As Long, _
    ByRef pcDescriptorsReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNextLogArchiveExtent = ctypes.windll.clfsw32.GetNextLogArchiveExtent
GetNextLogArchiveExtent.restype = wintypes.BOOL
GetNextLogArchiveExtent.argtypes = [
    ctypes.POINTER(None),  # pvArchiveContext : void* in/out
    ctypes.c_void_p,  # rgadExtent : CLS_ARCHIVE_DESCRIPTOR* in/out
    wintypes.DWORD,  # cDescriptors : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcDescriptorsReturned : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
GetNextLogArchiveExtent = Fiddle::Function.new(
  lib['GetNextLogArchiveExtent'],
  [
    Fiddle::TYPE_VOIDP,  # pvArchiveContext : void* in/out
    Fiddle::TYPE_VOIDP,  # rgadExtent : CLS_ARCHIVE_DESCRIPTOR* in/out
    -Fiddle::TYPE_INT,  # cDescriptors : DWORD
    Fiddle::TYPE_VOIDP,  # pcDescriptorsReturned : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn GetNextLogArchiveExtent(
        pvArchiveContext: *mut (),  // void* in/out
        rgadExtent: *mut CLS_ARCHIVE_DESCRIPTOR,  // CLS_ARCHIVE_DESCRIPTOR* in/out
        cDescriptors: u32,  // DWORD
        pcDescriptorsReturned: *mut u32  // DWORD* 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 GetNextLogArchiveExtent(IntPtr pvArchiveContext, IntPtr rgadExtent, uint cDescriptors, ref uint pcDescriptorsReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_GetNextLogArchiveExtent' -Namespace Win32 -PassThru
# $api::GetNextLogArchiveExtent(pvArchiveContext, rgadExtent, cDescriptors, pcDescriptorsReturned)

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

出力引数:

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