GetTempPathA

関数

一時ファイル用ディレクトリのパスを取得する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetTempPathA(
    DWORD nBufferLength,
    LPSTR lpBuffer   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値の最大値は MAX_PATH+1(261)です。

解説(Remarks)

メモ

アプリケーションは GetTempPath ではなく GetTempPath2 を呼び出すべきです。

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

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

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

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

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

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 透過的フェールオーバー (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  (ANSI / -A)
#include <windows.h>

DWORD GetTempPathA(
    DWORD nBufferLength,
    LPSTR lpBuffer   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetTempPathA(
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer   // LPSTR optional, out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTempPathA(
    nBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpBuffer As System.Text.StringBuilder   ' LPSTR optional, out
) As UInteger
End Function

' nBufferLength : DWORD
' lpBuffer : LPSTR optional, out
Declare PtrSafe Function GetTempPathA Lib "kernel32" ( _
    ByVal nBufferLength As Long, _
    ByVal lpBuffer As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTempPathA = ctypes.windll.kernel32.GetTempPathA
GetTempPathA.restype = wintypes.DWORD
GetTempPathA.argtypes = [
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPSTR,  # lpBuffer : LPSTR optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetTempPathA = Fiddle::Function.new(
  lib['GetTempPathA'],
  [
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetTempPathA(
        nBufferLength: u32,  // DWORD
        lpBuffer: *mut u8  // LPSTR optional, 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 GetTempPathA(uint nBufferLength, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetTempPathA' -Namespace Win32 -PassThru
# $api::GetTempPathA(nBufferLength, lpBuffer)

#uselib "KERNEL32.dll"
#func global GetTempPathA "GetTempPathA" sptr, sptr
; GetTempPathA nBufferLength, varptr(lpBuffer)   ; 戻り値は stat
; nBufferLength : DWORD -> "sptr"
; lpBuffer : LPSTR optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetTempPathA "GetTempPathA" int, var
; res = GetTempPathA(nBufferLength, lpBuffer)
; nBufferLength : DWORD -> "int"
; lpBuffer : LPSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetTempPathA "GetTempPathA" int, sptr
; res = GetTempPathA(nBufferLength, varptr(lpBuffer))
; nBufferLength : DWORD -> "int"
; lpBuffer : LPSTR optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。