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解析対象のTxFログレコードを格納したバッファポインタ。
RecordBufferLengthInBytesDWORDinRecordBufferのサイズをバイト単位で示す値。
NameBufferLPWSTRout抽出したファイル名を受け取るUnicodeバッファ。出力先となる。
NameBufferLengthInBytesDWORD*inoutNameBufferのサイズを示す入出力ポインタ。必要バイト数が返る。
TxfIdTXF_ID*outoptionalレコードに含まれるTxFファイルIDを受け取る構造体ポインタ。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

extern "txfw32" fn TxfLogRecordGetFileName(
    RecordBuffer: ?*anyopaque, // void*
    RecordBufferLengthInBytes: u32, // DWORD
    NameBuffer: [*c]u16, // LPWSTR out
    NameBufferLengthInBytes: [*c]u32, // DWORD* in/out
    TxfId: [*c]TXF_ID // TXF_ID* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc TxfLogRecordGetFileName(
    RecordBuffer: pointer,  # void*
    RecordBufferLengthInBytes: uint32,  # DWORD
    NameBuffer: ptr uint16,  # LPWSTR out
    NameBufferLengthInBytes: ptr uint32,  # DWORD* in/out
    TxfId: ptr TXF_ID  # TXF_ID* optional, out
): int32 {.importc: "TxfLogRecordGetFileName", stdcall, dynlib: "txfw32.dll".}
pragma(lib, "txfw32");
extern(Windows)
int TxfLogRecordGetFileName(
    void* RecordBuffer,   // void*
    uint RecordBufferLengthInBytes,   // DWORD
    wchar* NameBuffer,   // LPWSTR out
    uint* NameBufferLengthInBytes,   // DWORD* in/out
    TXF_ID* TxfId   // TXF_ID* optional, out
);
ccall((:TxfLogRecordGetFileName, "txfw32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt16}, Ptr{UInt32}, Ptr{TXF_ID}),
      RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
# RecordBuffer : void* -> Ptr{Cvoid}
# RecordBufferLengthInBytes : DWORD -> UInt32
# NameBuffer : LPWSTR out -> Ptr{UInt16}
# NameBufferLengthInBytes : DWORD* in/out -> Ptr{UInt32}
# TxfId : TXF_ID* optional, out -> Ptr{TXF_ID}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t TxfLogRecordGetFileName(
    void* RecordBuffer,
    uint32_t RecordBufferLengthInBytes,
    uint16_t* NameBuffer,
    uint32_t* NameBufferLengthInBytes,
    void* TxfId);
]]
local txfw32 = ffi.load("txfw32")
-- txfw32.TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
-- RecordBuffer : void*
-- RecordBufferLengthInBytes : DWORD
-- NameBuffer : LPWSTR out
-- NameBufferLengthInBytes : DWORD* in/out
-- TxfId : TXF_ID* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('txfw32.dll');
const TxfLogRecordGetFileName = lib.func('__stdcall', 'TxfLogRecordGetFileName', 'int32_t', ['void *', 'uint32_t', 'uint16_t *', 'uint32_t *', 'void *']);
// TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
// RecordBuffer : void* -> 'void *'
// RecordBufferLengthInBytes : DWORD -> 'uint32_t'
// NameBuffer : LPWSTR out -> 'uint16_t *'
// NameBufferLengthInBytes : DWORD* in/out -> 'uint32_t *'
// TxfId : TXF_ID* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("txfw32.dll", {
  TxfLogRecordGetFileName: { parameters: ["pointer", "u32", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId)
// RecordBuffer : void* -> "pointer"
// RecordBufferLengthInBytes : DWORD -> "u32"
// NameBuffer : LPWSTR out -> "buffer"
// NameBufferLengthInBytes : DWORD* in/out -> "pointer"
// TxfId : TXF_ID* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TxfLogRecordGetFileName(
    void* RecordBuffer,
    uint32_t RecordBufferLengthInBytes,
    uint16_t* NameBuffer,
    uint32_t* NameBufferLengthInBytes,
    void* TxfId);
C, "txfw32.dll");
// $ffi->TxfLogRecordGetFileName(RecordBuffer, RecordBufferLengthInBytes, NameBuffer, NameBufferLengthInBytes, TxfId);
// RecordBuffer : void*
// RecordBufferLengthInBytes : DWORD
// NameBuffer : LPWSTR out
// NameBufferLengthInBytes : DWORD* in/out
// TxfId : TXF_ID* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Txfw32 extends StdCallLibrary {
    Txfw32 INSTANCE = Native.load("txfw32", Txfw32.class);
    boolean TxfLogRecordGetFileName(
        Pointer RecordBuffer,   // void*
        int RecordBufferLengthInBytes,   // DWORD
        char[] NameBuffer,   // LPWSTR out
        IntByReference NameBufferLengthInBytes,   // DWORD* in/out
        Pointer TxfId   // TXF_ID* optional, out
    );
}
@[Link("txfw32")]
lib Libtxfw32
  fun TxfLogRecordGetFileName = TxfLogRecordGetFileName(
    RecordBuffer : Void*,   # void*
    RecordBufferLengthInBytes : UInt32,   # DWORD
    NameBuffer : UInt16*,   # LPWSTR out
    NameBufferLengthInBytes : UInt32*,   # DWORD* in/out
    TxfId : TXF_ID*   # TXF_ID* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TxfLogRecordGetFileNameNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Uint32>, Pointer<Void>);
typedef TxfLogRecordGetFileNameDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Uint32>, Pointer<Void>);
final TxfLogRecordGetFileName = DynamicLibrary.open('txfw32.dll')
    .lookupFunction<TxfLogRecordGetFileNameNative, TxfLogRecordGetFileNameDart>('TxfLogRecordGetFileName');
// RecordBuffer : void* -> Pointer<Void>
// RecordBufferLengthInBytes : DWORD -> Uint32
// NameBuffer : LPWSTR out -> Pointer<Utf16>
// NameBufferLengthInBytes : DWORD* in/out -> Pointer<Uint32>
// TxfId : TXF_ID* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TxfLogRecordGetFileName"
  c_TxfLogRecordGetFileName :: Ptr () -> Word32 -> CWString -> Ptr Word32 -> Ptr () -> IO CInt
-- RecordBuffer : void* -> Ptr ()
-- RecordBufferLengthInBytes : DWORD -> Word32
-- NameBuffer : LPWSTR out -> CWString
-- NameBufferLengthInBytes : DWORD* in/out -> Ptr Word32
-- TxfId : TXF_ID* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let txflogrecordgetfilename =
  foreign "TxfLogRecordGetFileName"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* RecordBuffer : void* -> (ptr void) *)
(* RecordBufferLengthInBytes : DWORD -> uint32_t *)
(* NameBuffer : LPWSTR out -> (ptr uint16_t) *)
(* NameBufferLengthInBytes : DWORD* in/out -> (ptr uint32_t) *)
(* TxfId : TXF_ID* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library txfw32 (t "txfw32.dll"))
(cffi:use-foreign-library txfw32)

(cffi:defcfun ("TxfLogRecordGetFileName" txf-log-record-get-file-name :convention :stdcall) :int32
  (record-buffer :pointer)   ; void*
  (record-buffer-length-in-bytes :uint32)   ; DWORD
  (name-buffer :pointer)   ; LPWSTR out
  (name-buffer-length-in-bytes :pointer)   ; DWORD* in/out
  (txf-id :pointer))   ; TXF_ID* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TxfLogRecordGetFileName = Win32::API::More->new('txfw32',
    'BOOL TxfLogRecordGetFileName(LPVOID RecordBuffer, DWORD RecordBufferLengthInBytes, LPWSTR NameBuffer, LPVOID NameBufferLengthInBytes, LPVOID TxfId)');
# my $ret = $TxfLogRecordGetFileName->Call($RecordBuffer, $RecordBufferLengthInBytes, $NameBuffer, $NameBufferLengthInBytes, $TxfId);
# RecordBuffer : void* -> LPVOID
# RecordBufferLengthInBytes : DWORD -> DWORD
# NameBuffer : LPWSTR out -> LPWSTR
# NameBufferLengthInBytes : DWORD* in/out -> LPVOID
# TxfId : TXF_ID* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型