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

GetTempPathW

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

シグネチャ

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

DWORD GetTempPathW(
    DWORD nBufferLength,
    LPWSTR lpBuffer   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

一時ファイル用に指定されたディレクトリのパスを取得します。(Unicode)

戻り値

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

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

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

解説(Remarks)

メモ

アプリケーションは GetTempPath ではなく GetTempPath2 を呼び出す必要があります。

GetTempPath 関数は、以下の順序で環境変数の存在を確認し、最初に見つかったパスを使用します。

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

シンボリックリンクの動作—パスがシンボリックリンクを指している場合、一時パス名はシンボリックリンクをそのまま保持します。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい

例については、Creating and Using a Temporary File を参照してください。

メモ

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

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

GetTempPathW = ctypes.windll.kernel32.GetTempPathW
GetTempPathW.restype = wintypes.DWORD
GetTempPathW.argtypes = [
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTempPathW = kernel32.NewProc("GetTempPathW")
)

// nBufferLength (DWORD), lpBuffer (LPWSTR optional, out)
r1, _, err := procGetTempPathW.Call(
	uintptr(nBufferLength),
	uintptr(lpBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetTempPathW(
  nBufferLength: DWORD;   // DWORD
  lpBuffer: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetTempPathW';
result := DllCall("KERNEL32\GetTempPathW"
    , "UInt", nBufferLength   ; DWORD
    , "Ptr", lpBuffer   ; LPWSTR optional, out
    , "UInt")   ; return: DWORD
●GetTempPathW(nBufferLength, lpBuffer) = DLL("KERNEL32.dll", "dword GetTempPathW(dword, char*)")
# 呼び出し: GetTempPathW(nBufferLength, lpBuffer)
# nBufferLength : DWORD -> "dword"
# lpBuffer : 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 GetTempPathW(
    nBufferLength: u32, // DWORD
    lpBuffer: [*c]u16 // LPWSTR optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetTempPathW(
    nBufferLength: uint32,  # DWORD
    lpBuffer: ptr uint16  # LPWSTR optional, out
): uint32 {.importc: "GetTempPathW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetTempPathW(
    uint nBufferLength,   // DWORD
    wchar* lpBuffer   // LPWSTR optional, out
);
ccall((:GetTempPathW, "KERNEL32.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt16}),
      nBufferLength, lpBuffer)
# nBufferLength : DWORD -> UInt32
# lpBuffer : LPWSTR optional, out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetTempPathW(
    uint32_t nBufferLength,
    uint16_t* lpBuffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetTempPathW(nBufferLength, lpBuffer)
-- nBufferLength : DWORD
-- lpBuffer : 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 GetTempPathW = lib.func('__stdcall', 'GetTempPathW', 'uint32_t', ['uint32_t', 'uint16_t *']);
// GetTempPathW(nBufferLength, lpBuffer)
// nBufferLength : DWORD -> 'uint32_t'
// lpBuffer : LPWSTR optional, out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetTempPathW: { parameters: ["u32", "buffer"], result: "u32" },
});
// lib.symbols.GetTempPathW(nBufferLength, lpBuffer)
// nBufferLength : DWORD -> "u32"
// lpBuffer : LPWSTR optional, out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetTempPathW(
    uint32_t nBufferLength,
    uint16_t* lpBuffer);
C, "KERNEL32.dll");
// $ffi->GetTempPathW(nBufferLength, lpBuffer);
// nBufferLength : DWORD
// lpBuffer : 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 GetTempPathW(
        int nBufferLength,   // DWORD
        char[] lpBuffer   // LPWSTR optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetTempPathW = GetTempPathW(
    nBufferLength : UInt32,   # DWORD
    lpBuffer : 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 GetTempPathWNative = Uint32 Function(Uint32, Pointer<Utf16>);
typedef GetTempPathWDart = int Function(int, Pointer<Utf16>);
final GetTempPathW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetTempPathWNative, GetTempPathWDart>('GetTempPathW');
// nBufferLength : DWORD -> Uint32
// lpBuffer : LPWSTR optional, out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTempPathW(
  nBufferLength: DWORD;   // DWORD
  lpBuffer: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetTempPathW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

文字セット違い
類似 API
公式の関連項目