Win32 API 日本語リファレンス
ホームStorage.FileSystem › TxfLogRecordGetFileName

TxfLogRecordGetFileName

関数
TxFログレコードからファイル名を取得する。
DLLtxfw32.dll呼出規約winapi

シグネチャ

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

BOOL TxfLogRecordGetFileName(
    void* RecordBuffer,
    DWORD RecordBufferLengthInBytes,
    LPWSTR NameBuffer,
    DWORD* NameBufferLengthInBytes,
    TXF_ID* TxfId   // optional
);

パラメーター

名前方向
RecordBuffervoid*in
RecordBufferLengthInBytesDWORDin
NameBufferLPWSTRout
NameBufferLengthInBytesDWORD*inout
TxfIdTXF_ID*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL TxfLogRecordGetFileName(
    void* RecordBuffer,
    DWORD RecordBufferLengthInBytes,
    LPWSTR NameBuffer,
    DWORD* NameBufferLengthInBytes,
    TXF_ID* TxfId   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("txfw32.dll", ExactSpelling = true)]
static extern bool TxfLogRecordGetFileName(
    IntPtr RecordBuffer,   // void*
    uint RecordBufferLengthInBytes,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder NameBuffer,   // LPWSTR out
    ref uint NameBufferLengthInBytes,   // DWORD* in/out
    IntPtr TxfId   // TXF_ID* optional, out
);
<DllImport("txfw32.dll", ExactSpelling:=True)>
Public Shared Function TxfLogRecordGetFileName(
    RecordBuffer As IntPtr,   ' void*
    RecordBufferLengthInBytes As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> NameBuffer As System.Text.StringBuilder,   ' LPWSTR out
    ByRef NameBufferLengthInBytes As UInteger,   ' DWORD* in/out
    TxfId As IntPtr   ' TXF_ID* optional, out
) As Boolean
End Function
' RecordBuffer : void*
' RecordBufferLengthInBytes : DWORD
' NameBuffer : LPWSTR out
' NameBufferLengthInBytes : DWORD* in/out
' TxfId : TXF_ID* optional, out
Declare PtrSafe Function TxfLogRecordGetFileName Lib "txfw32" ( _
    ByVal RecordBuffer As LongPtr, _
    ByVal RecordBufferLengthInBytes As Long, _
    ByVal NameBuffer As LongPtr, _
    ByRef NameBufferLengthInBytes As Long, _
    ByVal TxfId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TxfLogRecordGetFileName = ctypes.windll.txfw32.TxfLogRecordGetFileName
TxfLogRecordGetFileName.restype = wintypes.BOOL
TxfLogRecordGetFileName.argtypes = [
    ctypes.POINTER(None),  # RecordBuffer : void*
    wintypes.DWORD,  # RecordBufferLengthInBytes : DWORD
    wintypes.LPWSTR,  # NameBuffer : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # NameBufferLengthInBytes : DWORD* in/out
    ctypes.c_void_p,  # TxfId : TXF_ID* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('txfw32.dll')
TxfLogRecordGetFileName = Fiddle::Function.new(
  lib['TxfLogRecordGetFileName'],
  [
    Fiddle::TYPE_VOIDP,  # RecordBuffer : void*
    -Fiddle::TYPE_INT,  # RecordBufferLengthInBytes : DWORD
    Fiddle::TYPE_VOIDP,  # NameBuffer : LPWSTR out
    Fiddle::TYPE_VOIDP,  # NameBufferLengthInBytes : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # TxfId : TXF_ID* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "txfw32")]
extern "system" {
    fn TxfLogRecordGetFileName(
        RecordBuffer: *mut (),  // void*
        RecordBufferLengthInBytes: u32,  // DWORD
        NameBuffer: *mut u16,  // LPWSTR out
        NameBufferLengthInBytes: *mut u32,  // DWORD* in/out
        TxfId: *mut TXF_ID  // TXF_ID* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("txfw32.dll")]
public static extern bool TxfLogRecordGetFileName(IntPtr RecordBuffer, uint RecordBufferLengthInBytes, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder NameBuffer, ref uint NameBufferLengthInBytes, IntPtr TxfId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'txfw32_TxfLogRecordGetFileName' -Namespace Win32 -PassThru
# $api::TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
#uselib "txfw32.dll"
#func global TxfLogRecordGetFileName "TxfLogRecordGetFileName" sptr, sptr, sptr, sptr, sptr
; TxfLogRecordGetFileName RecordBuffer, RecordBufferLengthInBytes, varptr(NameBuffer), varptr(NameBufferLengthInBytes), varptr(TxfId)   ; 戻り値は stat
; RecordBuffer : void* -> "sptr"
; RecordBufferLengthInBytes : DWORD -> "sptr"
; NameBuffer : LPWSTR out -> "sptr"
; NameBufferLengthInBytes : DWORD* in/out -> "sptr"
; TxfId : TXF_ID* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "txfw32.dll"
#cfunc global TxfLogRecordGetFileName "TxfLogRecordGetFileName" sptr, int, var, var, var
; res = TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
; RecordBuffer : void* -> "sptr"
; RecordBufferLengthInBytes : DWORD -> "int"
; NameBuffer : LPWSTR out -> "var"
; NameBufferLengthInBytes : DWORD* in/out -> "var"
; TxfId : TXF_ID* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL TxfLogRecordGetFileName(void* RecordBuffer, DWORD RecordBufferLengthInBytes, LPWSTR NameBuffer, DWORD* NameBufferLengthInBytes, TXF_ID* TxfId)
#uselib "txfw32.dll"
#cfunc global TxfLogRecordGetFileName "TxfLogRecordGetFileName" intptr, int, var, var, var
; res = TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
; RecordBuffer : void* -> "intptr"
; RecordBufferLengthInBytes : DWORD -> "int"
; NameBuffer : LPWSTR out -> "var"
; NameBufferLengthInBytes : DWORD* in/out -> "var"
; TxfId : TXF_ID* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	txfw32 = windows.NewLazySystemDLL("txfw32.dll")
	procTxfLogRecordGetFileName = txfw32.NewProc("TxfLogRecordGetFileName")
)

// RecordBuffer (void*), RecordBufferLengthInBytes (DWORD), NameBuffer (LPWSTR out), NameBufferLengthInBytes (DWORD* in/out), TxfId (TXF_ID* optional, out)
r1, _, err := procTxfLogRecordGetFileName.Call(
	uintptr(RecordBuffer),
	uintptr(RecordBufferLengthInBytes),
	uintptr(NameBuffer),
	uintptr(NameBufferLengthInBytes),
	uintptr(TxfId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function TxfLogRecordGetFileName(
  RecordBuffer: Pointer;   // void*
  RecordBufferLengthInBytes: DWORD;   // DWORD
  NameBuffer: PWideChar;   // LPWSTR out
  NameBufferLengthInBytes: Pointer;   // DWORD* in/out
  TxfId: Pointer   // TXF_ID* optional, out
): BOOL; stdcall;
  external 'txfw32.dll' name 'TxfLogRecordGetFileName';
result := DllCall("txfw32\TxfLogRecordGetFileName"
    , "Ptr", RecordBuffer   ; void*
    , "UInt", RecordBufferLengthInBytes   ; DWORD
    , "Ptr", NameBuffer   ; LPWSTR out
    , "Ptr", NameBufferLengthInBytes   ; DWORD* in/out
    , "Ptr", TxfId   ; TXF_ID* optional, out
    , "Int")   ; return: BOOL
●TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId) = DLL("txfw32.dll", "bool TxfLogRecordGetFileName(void*, dword, char*, void*, void*)")
# 呼び出し: TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
# RecordBuffer : void* -> "void*"
# RecordBufferLengthInBytes : DWORD -> "dword"
# NameBuffer : LPWSTR out -> "char*"
# NameBufferLengthInBytes : DWORD* in/out -> "void*"
# TxfId : TXF_ID* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。