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

GetTempPath2A

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

シグネチャ

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

DWORD GetTempPath2A(
    DWORD BufferLength,
    LPSTR Buffer   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は 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  (ANSI / -A)
#include <windows.h>

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTempPath2A = kernel32.NewProc("GetTempPath2A")
)

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

extern "kernel32" fn GetTempPath2A(
    BufferLength: u32, // DWORD
    Buffer: [*c]u8 // LPSTR optional, out
) callconv(std.os.windows.WINAPI) u32;
proc GetTempPath2A(
    BufferLength: uint32,  # DWORD
    Buffer: ptr char  # LPSTR optional, out
): uint32 {.importc: "GetTempPath2A", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetTempPath2A(
    uint BufferLength,   // DWORD
    char* Buffer   // LPSTR optional, out
);
ccall((:GetTempPath2A, "KERNEL32.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt8}),
      BufferLength, Buffer)
# BufferLength : DWORD -> UInt32
# Buffer : LPSTR optional, out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetTempPath2A(
    uint32_t BufferLength,
    char* Buffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetTempPath2A(BufferLength, Buffer)
-- BufferLength : DWORD
-- Buffer : LPSTR optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetTempPath2A = lib.func('__stdcall', 'GetTempPath2A', 'uint32_t', ['uint32_t', 'char *']);
// GetTempPath2A(BufferLength, Buffer)
// BufferLength : DWORD -> 'uint32_t'
// Buffer : LPSTR optional, out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetTempPath2A: { parameters: ["u32", "buffer"], result: "u32" },
});
// lib.symbols.GetTempPath2A(BufferLength, Buffer)
// BufferLength : DWORD -> "u32"
// Buffer : LPSTR optional, out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetTempPath2A(
    uint32_t BufferLength,
    char* Buffer);
C, "KERNEL32.dll");
// $ffi->GetTempPath2A(BufferLength, Buffer);
// BufferLength : DWORD
// Buffer : LPSTR 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.ASCII_OPTIONS);
    int GetTempPath2A(
        int BufferLength,   // DWORD
        byte[] Buffer   // LPSTR optional, out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetTempPath2A = GetTempPath2A(
    BufferLength : UInt32,   # DWORD
    Buffer : UInt8*   # LPSTR 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 GetTempPath2ANative = Uint32 Function(Uint32, Pointer<Utf8>);
typedef GetTempPath2ADart = int Function(int, Pointer<Utf8>);
final GetTempPath2A = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetTempPath2ANative, GetTempPath2ADart>('GetTempPath2A');
// BufferLength : DWORD -> Uint32
// Buffer : LPSTR optional, out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTempPath2A(
  BufferLength: DWORD;   // DWORD
  Buffer: PAnsiChar   // LPSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetTempPath2A';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let gettemppath2a =
  foreign "GetTempPath2A"
    (uint32_t @-> string @-> returning uint32_t)
(* BufferLength : DWORD -> uint32_t *)
(* Buffer : LPSTR optional, out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetTempPath2A" get-temp-path2-a :convention :stdcall) :uint32
  (buffer-length :uint32)   ; DWORD
  (buffer :pointer))   ; LPSTR optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTempPath2A = Win32::API::More->new('KERNEL32',
    'DWORD GetTempPath2A(DWORD BufferLength, LPSTR Buffer)');
# my $ret = $GetTempPath2A->Call($BufferLength, $Buffer);
# BufferLength : DWORD -> DWORD
# Buffer : LPSTR optional, out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API