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

GetTempFileNameW

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetTempFileNameW(
    LPCWSTR lpPathName,
    LPCWSTR lpPrefixString,
    DWORD uUnique,
    LPWSTR lpTempFileName
);

パラメーター

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

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

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

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は一時ファイル名に使用された一意な数値を示します。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) あり
SMB 3.0 スケールアウト ファイル共有 (SOFS) あり
クラスター共有ボリューム ファイル システム (CsvFS) あり
回復性ファイル システム (ReFS) あり

使用例

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

メモ

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

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetTempFileNameW(
    LPCWSTR lpPathName,
    LPCWSTR lpPrefixString,
    DWORD uUnique,
    LPWSTR lpTempFileName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetTempFileNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpPathName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpPrefixString,   // LPCWSTR
    uint uUnique,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpTempFileName   // LPWSTR out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTempFileNameW(
    <MarshalAs(UnmanagedType.LPWStr)> lpPathName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpPrefixString As String,   ' LPCWSTR
    uUnique As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpTempFileName As System.Text.StringBuilder   ' LPWSTR out
) As UInteger
End Function
' lpPathName : LPCWSTR
' lpPrefixString : LPCWSTR
' uUnique : DWORD
' lpTempFileName : LPWSTR out
Declare PtrSafe Function GetTempFileNameW Lib "kernel32" ( _
    ByVal lpPathName As LongPtr, _
    ByVal lpPrefixString As LongPtr, _
    ByVal uUnique As Long, _
    ByVal lpTempFileName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTempFileNameW = kernel32.NewProc("GetTempFileNameW")
)

// lpPathName (LPCWSTR), lpPrefixString (LPCWSTR), uUnique (DWORD), lpTempFileName (LPWSTR out)
r1, _, err := procGetTempFileNameW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpPathName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpPrefixString))),
	uintptr(uUnique),
	uintptr(lpTempFileName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetTempFileNameW(
  lpPathName: PWideChar;   // LPCWSTR
  lpPrefixString: PWideChar;   // LPCWSTR
  uUnique: DWORD;   // DWORD
  lpTempFileName: PWideChar   // LPWSTR out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetTempFileNameW';
result := DllCall("KERNEL32\GetTempFileNameW"
    , "WStr", lpPathName   ; LPCWSTR
    , "WStr", lpPrefixString   ; LPCWSTR
    , "UInt", uUnique   ; DWORD
    , "Ptr", lpTempFileName   ; LPWSTR out
    , "UInt")   ; return: DWORD
●GetTempFileNameW(lpPathName, lpPrefixString, uUnique, lpTempFileName) = DLL("KERNEL32.dll", "dword GetTempFileNameW(char*, char*, dword, char*)")
# 呼び出し: GetTempFileNameW(lpPathName, lpPrefixString, uUnique, lpTempFileName)
# lpPathName : LPCWSTR -> "char*"
# lpPrefixString : LPCWSTR -> "char*"
# uUnique : DWORD -> "dword"
# lpTempFileName : LPWSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetTempFileNameW(
    lpPathName: [*c]const u16, // LPCWSTR
    lpPrefixString: [*c]const u16, // LPCWSTR
    uUnique: u32, // DWORD
    lpTempFileName: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetTempFileNameW(
    lpPathName: WideCString,  # LPCWSTR
    lpPrefixString: WideCString,  # LPCWSTR
    uUnique: uint32,  # DWORD
    lpTempFileName: ptr uint16  # LPWSTR out
): uint32 {.importc: "GetTempFileNameW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetTempFileNameW(
    const(wchar)* lpPathName,   // LPCWSTR
    const(wchar)* lpPrefixString,   // LPCWSTR
    uint uUnique,   // DWORD
    wchar* lpTempFileName   // LPWSTR out
);
ccall((:GetTempFileNameW, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, UInt32, Ptr{UInt16}),
      lpPathName, lpPrefixString, uUnique, lpTempFileName)
# lpPathName : LPCWSTR -> Cwstring
# lpPrefixString : LPCWSTR -> Cwstring
# uUnique : DWORD -> UInt32
# lpTempFileName : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetTempFileNameW(
    const uint16_t* lpPathName,
    const uint16_t* lpPrefixString,
    uint32_t uUnique,
    uint16_t* lpTempFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetTempFileNameW(lpPathName, lpPrefixString, uUnique, lpTempFileName)
-- lpPathName : LPCWSTR
-- lpPrefixString : LPCWSTR
-- uUnique : DWORD
-- lpTempFileName : LPWSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetTempFileNameW = lib.func('__stdcall', 'GetTempFileNameW', 'uint32_t', ['str16', 'str16', 'uint32_t', 'uint16_t *']);
// GetTempFileNameW(lpPathName, lpPrefixString, uUnique, lpTempFileName)
// lpPathName : LPCWSTR -> 'str16'
// lpPrefixString : LPCWSTR -> 'str16'
// uUnique : DWORD -> 'uint32_t'
// lpTempFileName : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetTempFileNameW: { parameters: ["buffer", "buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetTempFileNameW(lpPathName, lpPrefixString, uUnique, lpTempFileName)
// lpPathName : LPCWSTR -> "buffer"
// lpPrefixString : LPCWSTR -> "buffer"
// uUnique : DWORD -> "u32"
// lpTempFileName : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetTempFileNameW(
    const uint16_t* lpPathName,
    const uint16_t* lpPrefixString,
    uint32_t uUnique,
    uint16_t* lpTempFileName);
C, "KERNEL32.dll");
// $ffi->GetTempFileNameW(lpPathName, lpPrefixString, uUnique, lpTempFileName);
// lpPathName : LPCWSTR
// lpPrefixString : LPCWSTR
// uUnique : DWORD
// lpTempFileName : LPWSTR 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.UNICODE_OPTIONS);
    int GetTempFileNameW(
        WString lpPathName,   // LPCWSTR
        WString lpPrefixString,   // LPCWSTR
        int uUnique,   // DWORD
        char[] lpTempFileName   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetTempFileNameW = GetTempFileNameW(
    lpPathName : UInt16*,   # LPCWSTR
    lpPrefixString : UInt16*,   # LPCWSTR
    uUnique : UInt32,   # DWORD
    lpTempFileName : UInt16*   # LPWSTR out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("GetTempFileNameW" get-temp-file-name-w :convention :stdcall) :uint32
  (lp-path-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-prefix-string (:string :encoding :utf-16le))   ; LPCWSTR
  (u-unique :uint32)   ; DWORD
  (lp-temp-file-name :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTempFileNameW = Win32::API::More->new('KERNEL32',
    'DWORD GetTempFileNameW(LPCWSTR lpPathName, LPCWSTR lpPrefixString, DWORD uUnique, LPWSTR lpTempFileName)');
# my $ret = $GetTempFileNameW->Call($lpPathName, $lpPrefixString, $uUnique, $lpTempFileName);
# lpPathName : LPCWSTR -> LPCWSTR
# lpPrefixString : LPCWSTR -> LPCWSTR
# uUnique : DWORD -> DWORD
# lpTempFileName : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い