GetTempPathA 関数 (fileapi.h)
一時ファイル用に指定されたディレクトリのパスを取得します。
構文
DWORD GetTempPathA(
[in] DWORD nBufferLength,
[out] LPSTR lpBuffer
);
パラメーター
[in] nBufferLength
lpBufferで識別される文字列バッファーのサイズ (TCHAR)。
[out] lpBuffer
一時ファイル パスを指定する null で終わる文字列を受け取る文字列バッファーへのポインター。 返される文字列は、"C:\TEMP\" などの円記号で終わります。
戻り値
関数が成功した場合、戻り値は、終端の null 文字を含まない、lpBufferにコピーされた文字列の長さ (
関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError
可能な最大戻り値は、+1 (261) MAX_PATHです。
備考
手記
アプリでは、GetTempPathではなく、
GetTempPath 関数は、環境変数の存在を次の順序でチェックし、最初に見つかったパスを使用します。
- TMP 環境変数で指定されたパス。
- TEMP 環境変数で指定されたパス。
- USERPROFILE 環境変数で指定されたパス。
- Windows ディレクトリ。
シンボリック リンクの動作 : パスがシンボリック リンクを指している場合、一時パス名はシンボリック リンクを保持します。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。
テクノロジー | サポート |
---|---|
サーバー メッセージ ブロック (SMB) 3.0 プロトコル | はい |
SMB 3.0 透過的フェールオーバー (TFO) | はい |
SMB 3.0 とスケールアウト ファイル共有 (SO) | はい |
クラスター共有ボリューム ファイル システム (CsvFS) | はい |
回復性のあるファイル システム (ReFS) | はい |
例
例については、「一時ファイルの作成と使用」を参照してください。
手記
fileapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetTempPath を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows XP [デスクトップ アプリ |UWP アプリ] |
サポートされる最小サーバー | Windows Server 2003 [デスクトップ アプリ |UWP アプリ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | fileapi.h (Windows.h を含む) |
ライブラリ | Kernel32.lib |
DLL | Kernel32.dll |
関連項目
GetTempFileName を
シンボリック リンク の