ホーム › Storage.FileSystem › GetLogContainerName

GetLogContainerName

関数

論理コンテナIDからCLFSログコンテナ名を取得する。

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

シグネチャ

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

BOOL GetLogContainerName(
    HANDLE hLog,
    DWORD cidLogicalContainer,
    LPCWSTR pwstrContainerName,
    DWORD cLenContainerName,
    DWORD* pcActualLenContainerName
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	CreateLogFile の呼び出しが成功して取得されたログへのハンドル。このログハンドルは、ログストリームまたは物理ログを参照できます。
cidLogicalContainer	DWORD	in	コンテナーに関連付けられた一意の識別子。
pwstrContainerName	LPCWSTR	in	ログコンテナーの完全パスと名前をワイド文字で受け取る、ユーザーが割り当てたバッファーへのポインター。
cLenContainerName	DWORD	in	pwstrContainerName が指すバッファーのサイズ(文字単位)。
pcActualLenContainerName	DWORD*	inout	取得されたコンテナーの完全パス名の実際の文字数を受け取る変数へのポインター。関数が成功した場合、このパラメーターの値は cLenContainerName 以下になります。バッファーがコンテナーの完全パス名全体を格納するのに十分な大きさでない場合、関数は ERROR_MORE_DATA で失敗し、このパラメーターには完全パス名に必要なサイズが設定されます。その他の失敗の場合、この値は未定義です。

戻り値の型: 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 GetLogContainerName(
    HANDLE hLog,
    DWORD cidLogicalContainer,
    LPCWSTR pwstrContainerName,
    DWORD cLenContainerName,
    DWORD* pcActualLenContainerName
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetLogContainerName(
    IntPtr hLog,   // HANDLE
    uint cidLogicalContainer,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pwstrContainerName,   // LPCWSTR
    uint cLenContainerName,   // DWORD
    ref uint pcActualLenContainerName   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLogContainerName(
    hLog As IntPtr,   ' HANDLE
    cidLogicalContainer As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwstrContainerName As String,   ' LPCWSTR
    cLenContainerName As UInteger,   ' DWORD
    ByRef pcActualLenContainerName As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' cidLogicalContainer : DWORD
' pwstrContainerName : LPCWSTR
' cLenContainerName : DWORD
' pcActualLenContainerName : DWORD* in/out
Declare PtrSafe Function GetLogContainerName Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal cidLogicalContainer As Long, _
    ByVal pwstrContainerName As LongPtr, _
    ByVal cLenContainerName As Long, _
    ByRef pcActualLenContainerName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetLogContainerName = ctypes.windll.clfsw32.GetLogContainerName
GetLogContainerName.restype = wintypes.BOOL
GetLogContainerName.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    wintypes.DWORD,  # cidLogicalContainer : DWORD
    wintypes.LPCWSTR,  # pwstrContainerName : LPCWSTR
    wintypes.DWORD,  # cLenContainerName : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcActualLenContainerName : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
GetLogContainerName = Fiddle::Function.new(
  lib['GetLogContainerName'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    -Fiddle::TYPE_INT,  # cidLogicalContainer : DWORD
    Fiddle::TYPE_VOIDP,  # pwstrContainerName : LPCWSTR
    -Fiddle::TYPE_INT,  # cLenContainerName : DWORD
    Fiddle::TYPE_VOIDP,  # pcActualLenContainerName : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn GetLogContainerName(
        hLog: *mut core::ffi::c_void,  // HANDLE
        cidLogicalContainer: u32,  // DWORD
        pwstrContainerName: *const u16,  // LPCWSTR
        cLenContainerName: u32,  // DWORD
        pcActualLenContainerName: *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 GetLogContainerName(IntPtr hLog, uint cidLogicalContainer, [MarshalAs(UnmanagedType.LPWStr)] string pwstrContainerName, uint cLenContainerName, ref uint pcActualLenContainerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_GetLogContainerName' -Namespace Win32 -PassThru
# $api::GetLogContainerName(hLog, cidLogicalContainer, pwstrContainerName, cLenContainerName, pcActualLenContainerName)

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

出力引数:

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