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

GetTempPath2W

関数
一時ファイル用ディレクトリのパスを取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

DWORD GetTempPath2W(
    DWORD BufferLength,
    LPWSTR Buffer   // optional
);

パラメーター

名前方向説明
BufferLengthDWORDinBuffer で指定される文字列バッファのサイズを TCHARs 単位で指定します。
BufferLPWSTRoutoptional一時ファイルのパスを示す null 終端文字列を受け取る文字列バッファへのポインターです。返される文字列はバックスラッシュで終わります(例: "C:\TEMP\")。

戻り値の型: DWORD

公式ドキュメント

呼び出し元プロセスの権限に基づいて、一時ファイル用に指定されたディレクトリのパスを取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は Buffer にコピーされた文字列の長さ(TCHARs 単位、終端の null 文字は含まない)です。戻り値が BufferLength より大きい場合、戻り値はパスを格納するために必要なバッファの長さ(TCHARs 単位)です。

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

戻り値として取り得る最大値は MAX_PATH+1 (261) です。

解説(Remarks)

この関数を SYSTEM として実行されているプロセスから呼び出すと、パス C:\Windows\SystemTemp が返されます。このディレクトリは SYSTEM 以外のプロセスからはアクセスできません。SYSTEM 以外のプロセスの場合、GetTempPath2GetTempPath と同じ動作になります。

システムプロセスの場合、GetTempPath2 関数は環境変数 SystemTemp の存在を確認します。この環境変数が設定されている場合、C: ドライブ上の既定のシステム提供パスの代わりに、環境変数の値をパスとして使用します。

メモ

GetTempPath2 が存在し、既定で C:\Windows\SystemTemp を返すのは、このディレクトリが一般的なパスリダイレクトの問題を防ぐ適切なアクセス許可で ACL 設定されているためです。セキュリティ上の理由から、SystemTemp 環境変数には、SYSTEM プロセスまたは管理者のみがアクセスできるアクセス許可を持つディレクトリのみを設定してください。

システム以外のプロセスの場合、GetTempPath2 関数は次の順序で環境変数の存在を確認し、最初に見つかったパスを使用します。

  1. TMP 環境変数で指定されたパス。
  2. TEMP 環境変数で指定されたパス。
  3. USERPROFILE 環境変数で指定されたパス。
  4. Windows ディレクトリ。

この関数はパスが存在するかどうかを検証せず、現在のプロセスがそのパスに対して何らかのアクセス権を持っているかどうかもテストしないことに注意してください。GetTempPath2 関数は、前述の環境変数の検索順序に基づいて完全修飾パスを指定する、適切に書式設定された文字列を返します。アプリケーションは、ファイル I/O 操作に使用する前に、パスの存在とパスへの十分なアクセス権を検証する必要があります。

シンボリックリンクの動作: パスがシンボリックリンクを指す場合、一時パス名はシンボリックリンクを維持します。

Windows 8 および Windows Server 2012 では、この関数は次の技術でサポートされています。

技術 サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 トランスペアレントフェールオーバー (TFO) はい
スケールアウトファイル共有を使用した SMB 3.0 (SO) はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
復元性ファイルシステム (ReFS) はい
メモ

2025 年 3 月以降にリリースされた Windows 更新プログラムがインストールされている場合、この API は Windows 10 バージョン 1607 (ビルド 14393.7876) 以降および Windows Server 2016 ビルド 14393.7876 以降のバージョンでサポートされます。詳細については、KB5053594 を参照してください。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetTempPath2W(
    DWORD BufferLength,
    LPWSTR Buffer   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetTempPath2W(
    uint BufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer   // LPWSTR optional, out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetTempPath2W(
    BufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> Buffer As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function
' BufferLength : DWORD
' Buffer : LPWSTR optional, out
Declare PtrSafe Function GetTempPath2W Lib "kernel32" ( _
    ByVal BufferLength As Long, _
    ByVal Buffer 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

GetTempPath2W = ctypes.windll.kernel32.GetTempPath2W
GetTempPath2W.restype = wintypes.DWORD
GetTempPath2W.argtypes = [
    wintypes.DWORD,  # BufferLength : DWORD
    wintypes.LPWSTR,  # Buffer : LPWSTR optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTempPath2W = kernel32.NewProc("GetTempPath2W")
)

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

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

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

foreign import stdcall safe "GetTempPath2W"
  c_GetTempPath2W :: Word32 -> CWString -> IO Word32
-- BufferLength : DWORD -> Word32
-- Buffer : LPWSTR optional, out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettemppath2w =
  foreign "GetTempPath2W"
    (uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* BufferLength : DWORD -> uint32_t *)
(* Buffer : LPWSTR optional, 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 ("GetTempPath2W" get-temp-path2-w :convention :stdcall) :uint32
  (buffer-length :uint32)   ; DWORD
  (buffer :pointer))   ; LPWSTR optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTempPath2W = Win32::API::More->new('KERNEL32',
    'DWORD GetTempPath2W(DWORD BufferLength, LPWSTR Buffer)');
# my $ret = $GetTempPath2W->Call($BufferLength, $Buffer);
# BufferLength : DWORD -> DWORD
# Buffer : LPWSTR optional, out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API