ホーム › System.Diagnostics.Debug › TouchFileTimes

TouchFileTimes

関数

ファイルのタイムスタンプを更新する。

DLLimagehlp.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL TouchFileTimes(
    HANDLE FileHandle,
    SYSTEMTIME* pSystemTime   // optional
);

パラメーター

名前	型	方向	説明
FileHandle	HANDLE	in	対象のファイルへのハンドル。
pSystemTime	SYSTEMTIME*	inoptional	SYSTEMTIME 構造体へのポインター。このパラメーターが NULL の場合、現在のシステム日時が使用されます。

戻り値の型: BOOL

公式ドキュメント

指定されたファイルが最後に変更された日時を更新します。

戻り値

関数が成功した場合、戻り値は TRUE です。

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

解説(Remarks)

このような ImageHlp 関数はすべてシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期させる必要があります。

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

各言語での呼び出し定義

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

BOOL TouchFileTimes(
    HANDLE FileHandle,
    SYSTEMTIME* pSystemTime   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TouchFileTimes(
    IntPtr FileHandle,   // HANDLE
    IntPtr pSystemTime   // SYSTEMTIME* optional
);

<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TouchFileTimes(
    FileHandle As IntPtr,   ' HANDLE
    pSystemTime As IntPtr   ' SYSTEMTIME* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FileHandle : HANDLE
' pSystemTime : SYSTEMTIME* optional
Declare PtrSafe Function TouchFileTimes Lib "imagehlp" ( _
    ByVal FileHandle As LongPtr, _
    ByVal pSystemTime As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TouchFileTimes = ctypes.windll.imagehlp.TouchFileTimes
TouchFileTimes.restype = wintypes.BOOL
TouchFileTimes.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_void_p,  # pSystemTime : SYSTEMTIME* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
TouchFileTimes = Fiddle::Function.new(
  lib['TouchFileTimes'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pSystemTime : SYSTEMTIME* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "imagehlp")]
extern "system" {
    fn TouchFileTimes(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        pSystemTime: *mut SYSTEMTIME  // SYSTEMTIME* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern bool TouchFileTimes(IntPtr FileHandle, IntPtr pSystemTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_TouchFileTimes' -Namespace Win32 -PassThru
# $api::TouchFileTimes(FileHandle, pSystemTime)

#uselib "imagehlp.dll"
#func global TouchFileTimes "TouchFileTimes" sptr, sptr
; TouchFileTimes FileHandle, varptr(pSystemTime)   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; pSystemTime : SYSTEMTIME* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "imagehlp.dll"
#cfunc global TouchFileTimes "TouchFileTimes" sptr, var
; res = TouchFileTimes(FileHandle, pSystemTime)
; FileHandle : HANDLE -> "sptr"
; pSystemTime : SYSTEMTIME* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "imagehlp.dll"
#cfunc global TouchFileTimes "TouchFileTimes" sptr, sptr
; res = TouchFileTimes(FileHandle, varptr(pSystemTime))
; FileHandle : HANDLE -> "sptr"
; pSystemTime : SYSTEMTIME* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。