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

GetTempFileNameA

関数
一時ファイル用の一意な名前を生成する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetTempFileNameA(
    LPCSTR lpPathName,
    LPCSTR lpPrefixString,
    DWORD uUnique,
    LPSTR lpTempFileName
);

パラメーター

名前方向説明
lpPathNameLPCSTRinファイル名に使用するディレクトリパスです。アプリケーションは通常、カレントディレクトリを表すピリオド (.)、または GetTempPath2 関数の結果を指定します。この文字列は MAX_PATH–14 文字を超えることはできません。超えた場合、GetTempFileName は失敗します。このパラメーターが NULL の場合、関数は失敗します。
lpPrefixStringLPCSTRinnull で終端されるプレフィックス文字列です。関数はこの文字列の先頭最大 3 文字をファイル名のプレフィックスとして使用します。この文字列は OEM 定義の文字セットに含まれる文字で構成されている必要があります。
uUniqueDWORDin

一時ファイル名の作成に使用される符号なし整数です。詳細については「解説」を参照してください。

uUnique が 0 の場合、関数は現在のシステム時刻を使用して一意なファイル名を生成しようとします。ファイルが既に存在する場合は、その数値が 1 ずつ増やされ、関数はそのファイルが既に存在するかどうかをテストします。これは一意なファイル名が見つかるまで続けられ、関数はその名前のファイルを作成して閉じます。なお、uUnique が 0 以外の場合、関数はファイル名の一意性を検証しようとしません。

lpTempFileNameLPSTRout一時ファイル名を受け取るバッファーへのポインターです。このバッファーは、パスと終端の null 文字を格納できるように MAX_PATH 文字分のサイズが必要です。

戻り値の型: DWORD

公式ドキュメント

一時ファイルの名前を作成します。一意なファイル名が生成された場合は、空のファイルが作成され、そのハンドルは解放されます。一意でない場合は、ファイル名のみが生成されます。(GetTempFileNameA)

戻り値

関数が成功した場合、戻り値は一時ファイル名に使用された一意な数値を表します。uUnique パラメーターが 0 以外の場合、戻り値はその同じ数値を表します。

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

以下は、考えられる戻り値の一覧です。

戻り値 説明
ERROR_BUFFER_OVERFLOW lpPathName パラメーターが指す文字列の長さが MAX_PATH–14 文字を超えています。

解説(Remarks)

GetTempFileName 関数は、次の形式の一時ファイル名を作成します。

<path>\<pre><uuuu>.TMP

次の表に、ファイル名の構文を示します。

構成要素 意味
<path> lpPathName パラメーターで指定されたパス
<pre> lpPrefixString 文字列の先頭 3 文字
<uuuu> uUnique の 16 進数値

uUnique が 0 の場合、GetTempFileName は空のファイルを作成して閉じます。uUnique が 0 以外の場合は、ファイルを自分で作成する必要があります。この場合はファイル名のみが作成されます。GetTempFileName はファイル名が一意であることを保証できないためです。

uUnique パラメーターの下位 16 ビットのみが使用されます。このため、lpPathName および lpPrefixString パラメーターが同じである限り、GetTempFileName が生成できる一意なファイル名は最大 65,535 個に制限されます。

ファイル名の生成に使用されるアルゴリズムの性質上、同じプレフィックスで多数のファイルを作成する場合、GetTempFileName のパフォーマンスが低下することがあります。そのような場合は、GUID に基づいて一意なファイル名を構築することをお勧めします。また、現在のプロセス ID をプレフィックス文字列に付加することで、並列操作における衝突の可能性を減らすこともできます。

この関数で名前が作成された一時ファイルは、自動的には削除されません。これらのファイルを削除するには、DeleteFile を呼び出してください。

ANSI 文字列の変換時に発生する問題を回避するため、アプリケーションは一時ファイルを作成するために CreateFile 関数を呼び出してください。

Windows 8 および Windows Server 2012 以降、この関数は次のテクノロジでサポートされています。

テクノロジ サポート状況
Server Message Block (SMB) 3.0 プロトコル あり
SMB 3.0 透過的フェールオーバー (TFO) あり
スケールアウトファイル共有 (SOFS) を使用した SMB 3.0 あり
クラスター共有ボリュームファイルシステム (CsvFS) あり
回復性ファイルシステム (ReFS) あり

例については、一時ファイルの作成と使用を参照してください。

メモ

fileapi.h ヘッダーは GetTempFileName を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetTempFileNameA(
    LPCSTR lpPathName,
    LPCSTR lpPrefixString,
    DWORD uUnique,
    LPSTR lpTempFileName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetTempFileNameA(
    [MarshalAs(UnmanagedType.LPStr)] string lpPathName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpPrefixString,   // LPCSTR
    uint uUnique,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTempFileName   // LPSTR out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTempFileNameA(
    <MarshalAs(UnmanagedType.LPStr)> lpPathName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpPrefixString As String,   ' LPCSTR
    uUnique As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpTempFileName As System.Text.StringBuilder   ' LPSTR out
) As UInteger
End Function
' lpPathName : LPCSTR
' lpPrefixString : LPCSTR
' uUnique : DWORD
' lpTempFileName : LPSTR out
Declare PtrSafe Function GetTempFileNameA Lib "kernel32" ( _
    ByVal lpPathName As String, _
    ByVal lpPrefixString As String, _
    ByVal uUnique As Long, _
    ByVal lpTempFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetTempFileNameA = ctypes.windll.kernel32.GetTempFileNameA
GetTempFileNameA.restype = wintypes.DWORD
GetTempFileNameA.argtypes = [
    wintypes.LPCSTR,  # lpPathName : LPCSTR
    wintypes.LPCSTR,  # lpPrefixString : LPCSTR
    wintypes.DWORD,  # uUnique : DWORD
    wintypes.LPSTR,  # lpTempFileName : LPSTR out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetTempFileNameA = Fiddle::Function.new(
  lib['GetTempFileNameA'],
  [
    Fiddle::TYPE_VOIDP,  # lpPathName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpPrefixString : LPCSTR
    -Fiddle::TYPE_INT,  # uUnique : DWORD
    Fiddle::TYPE_VOIDP,  # lpTempFileName : LPSTR out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetTempFileNameA(
        lpPathName: *const u8,  // LPCSTR
        lpPrefixString: *const u8,  // LPCSTR
        uUnique: u32,  // DWORD
        lpTempFileName: *mut u8  // LPSTR out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint GetTempFileNameA([MarshalAs(UnmanagedType.LPStr)] string lpPathName, [MarshalAs(UnmanagedType.LPStr)] string lpPrefixString, uint uUnique, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTempFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetTempFileNameA' -Namespace Win32 -PassThru
# $api::GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
#uselib "KERNEL32.dll"
#func global GetTempFileNameA "GetTempFileNameA" sptr, sptr, sptr, sptr
; GetTempFileNameA lpPathName, lpPrefixString, uUnique, varptr(lpTempFileName)   ; 戻り値は stat
; lpPathName : LPCSTR -> "sptr"
; lpPrefixString : LPCSTR -> "sptr"
; uUnique : DWORD -> "sptr"
; lpTempFileName : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetTempFileNameA "GetTempFileNameA" str, str, int, var
; res = GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
; lpPathName : LPCSTR -> "str"
; lpPrefixString : LPCSTR -> "str"
; uUnique : DWORD -> "int"
; lpTempFileName : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetTempFileNameA(LPCSTR lpPathName, LPCSTR lpPrefixString, DWORD uUnique, LPSTR lpTempFileName)
#uselib "KERNEL32.dll"
#cfunc global GetTempFileNameA "GetTempFileNameA" str, str, int, var
; res = GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
; lpPathName : LPCSTR -> "str"
; lpPrefixString : LPCSTR -> "str"
; uUnique : DWORD -> "int"
; lpTempFileName : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTempFileNameA = kernel32.NewProc("GetTempFileNameA")
)

// lpPathName (LPCSTR), lpPrefixString (LPCSTR), uUnique (DWORD), lpTempFileName (LPSTR out)
r1, _, err := procGetTempFileNameA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpPathName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpPrefixString))),
	uintptr(uUnique),
	uintptr(lpTempFileName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetTempFileNameA(
  lpPathName: PAnsiChar;   // LPCSTR
  lpPrefixString: PAnsiChar;   // LPCSTR
  uUnique: DWORD;   // DWORD
  lpTempFileName: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetTempFileNameA';
result := DllCall("KERNEL32\GetTempFileNameA"
    , "AStr", lpPathName   ; LPCSTR
    , "AStr", lpPrefixString   ; LPCSTR
    , "UInt", uUnique   ; DWORD
    , "Ptr", lpTempFileName   ; LPSTR out
    , "UInt")   ; return: DWORD
●GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName) = DLL("KERNEL32.dll", "dword GetTempFileNameA(char*, char*, dword, char*)")
# 呼び出し: GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
# lpPathName : LPCSTR -> "char*"
# lpPrefixString : LPCSTR -> "char*"
# uUnique : DWORD -> "dword"
# lpTempFileName : LPSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetTempFileNameA(
    lpPathName: [*c]const u8, // LPCSTR
    lpPrefixString: [*c]const u8, // LPCSTR
    uUnique: u32, // DWORD
    lpTempFileName: [*c]u8 // LPSTR out
) callconv(std.os.windows.WINAPI) u32;
proc GetTempFileNameA(
    lpPathName: cstring,  # LPCSTR
    lpPrefixString: cstring,  # LPCSTR
    uUnique: uint32,  # DWORD
    lpTempFileName: ptr char  # LPSTR out
): uint32 {.importc: "GetTempFileNameA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetTempFileNameA(
    const(char)* lpPathName,   // LPCSTR
    const(char)* lpPrefixString,   // LPCSTR
    uint uUnique,   // DWORD
    char* lpTempFileName   // LPSTR out
);
ccall((:GetTempFileNameA, "KERNEL32.dll"), stdcall, UInt32,
      (Cstring, Cstring, UInt32, Ptr{UInt8}),
      lpPathName, lpPrefixString, uUnique, lpTempFileName)
# lpPathName : LPCSTR -> Cstring
# lpPrefixString : LPCSTR -> Cstring
# uUnique : DWORD -> UInt32
# lpTempFileName : LPSTR out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetTempFileNameA(
    const char* lpPathName,
    const char* lpPrefixString,
    uint32_t uUnique,
    char* lpTempFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
-- lpPathName : LPCSTR
-- lpPrefixString : LPCSTR
-- uUnique : DWORD
-- lpTempFileName : LPSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetTempFileNameA = lib.func('__stdcall', 'GetTempFileNameA', 'uint32_t', ['str', 'str', 'uint32_t', 'char *']);
// GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
// lpPathName : LPCSTR -> 'str'
// lpPrefixString : LPCSTR -> 'str'
// uUnique : DWORD -> 'uint32_t'
// lpTempFileName : LPSTR out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetTempFileNameA: { parameters: ["buffer", "buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName)
// lpPathName : LPCSTR -> "buffer"
// lpPrefixString : LPCSTR -> "buffer"
// uUnique : DWORD -> "u32"
// lpTempFileName : LPSTR out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetTempFileNameA(
    const char* lpPathName,
    const char* lpPrefixString,
    uint32_t uUnique,
    char* lpTempFileName);
C, "KERNEL32.dll");
// $ffi->GetTempFileNameA(lpPathName, lpPrefixString, uUnique, lpTempFileName);
// lpPathName : LPCSTR
// lpPrefixString : LPCSTR
// uUnique : DWORD
// lpTempFileName : LPSTR 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    int GetTempFileNameA(
        String lpPathName,   // LPCSTR
        String lpPrefixString,   // LPCSTR
        int uUnique,   // DWORD
        byte[] lpTempFileName   // LPSTR out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetTempFileNameA = GetTempFileNameA(
    lpPathName : UInt8*,   # LPCSTR
    lpPrefixString : UInt8*,   # LPCSTR
    uUnique : UInt32,   # DWORD
    lpTempFileName : UInt8*   # LPSTR out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetTempFileNameANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Utf8>);
typedef GetTempFileNameADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>);
final GetTempFileNameA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetTempFileNameANative, GetTempFileNameADart>('GetTempFileNameA');
// lpPathName : LPCSTR -> Pointer<Utf8>
// lpPrefixString : LPCSTR -> Pointer<Utf8>
// uUnique : DWORD -> Uint32
// lpTempFileName : LPSTR out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTempFileNameA(
  lpPathName: PAnsiChar;   // LPCSTR
  lpPrefixString: PAnsiChar;   // LPCSTR
  uUnique: DWORD;   // DWORD
  lpTempFileName: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetTempFileNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTempFileNameA"
  c_GetTempFileNameA :: CString -> CString -> Word32 -> CString -> IO Word32
-- lpPathName : LPCSTR -> CString
-- lpPrefixString : LPCSTR -> CString
-- uUnique : DWORD -> Word32
-- lpTempFileName : LPSTR out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettempfilenamea =
  foreign "GetTempFileNameA"
    (string @-> string @-> uint32_t @-> string @-> returning uint32_t)
(* lpPathName : LPCSTR -> string *)
(* lpPrefixString : LPCSTR -> string *)
(* uUnique : DWORD -> uint32_t *)
(* lpTempFileName : LPSTR out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetTempFileNameA" get-temp-file-name-a :convention :stdcall) :uint32
  (lp-path-name :string)   ; LPCSTR
  (lp-prefix-string :string)   ; LPCSTR
  (u-unique :uint32)   ; DWORD
  (lp-temp-file-name :pointer))   ; LPSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTempFileNameA = Win32::API::More->new('KERNEL32',
    'DWORD GetTempFileNameA(LPCSTR lpPathName, LPCSTR lpPrefixString, DWORD uUnique, LPSTR lpTempFileName)');
# my $ret = $GetTempFileNameA->Call($lpPathName, $lpPrefixString, $uUnique, $lpTempFileName);
# lpPathName : LPCSTR -> LPCSTR
# lpPrefixString : LPCSTR -> LPCSTR
# uUnique : DWORD -> DWORD
# lpTempFileName : LPSTR out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い