GetTempPathA 函式 (fileapi.h)

  • 發行項

擷取為暫存檔案指定的目錄路徑。

語法

DWORD GetTempPathA(
  [in]  DWORD nBufferLength,
  [out] LPSTR lpBuffer
);

參數

[in] nBufferLength

TCHAR中由 lpBuffer識別的字串緩衝區大小。

[out] lpBuffer

字串緩衝區的指標，接收指定暫存檔路徑的 Null 終止字串。 傳回的字串以反斜線結尾，例如 「C：\TEMP\」。

傳回值

如果函式成功，傳回值會是複製到lpBuffer之字串的長度，不包括終止 Null 字元。 如果傳回值大於 nBufferLength，則傳回值會是保留路徑所需的緩衝區長度，以 TCHAR為單位。

如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

可能的傳回值上限為 MAX_PATH+1 (261) 。

備註

注意

應用程式應該呼叫 GetTempPath2 ，而不是 GetTempPath。

GetTempPath函式會依下列順序檢查環境變數是否存在，並使用找到的第一個路徑：

  1. TMP 環境變數指定的路徑。
  2. TEMP 環境變數指定的路徑。
  3. USERPROFILE 環境變數指定的路徑。
  4. Windows 目錄。
請注意，函式不會驗證路徑是否存在，也不會測試目前進程是否有任何類型的路徑存取權限。 GetTempPath函式會傳回格式正確的字串，此字串會根據先前指定的環境變數搜尋順序來指定完整路徑。 在檔案 I/O 作業的任何用途之前，應用程式應該先確認路徑是否存在以及路徑的適當存取權限。

符號連結行為： 如果路徑指向符號連結，暫存路徑名稱會維護任何符號連結。

在 Windows 8 和 Windows Server 2012 中，下列技術支援此函式。

技術 支援
伺服器訊息區 (SMB) 3.0 通訊協定 是
SMB 3.0 透明容錯移轉 (TFO) 是
具有向外延展檔案共用的 SMB 3.0 (SO) 是
叢集共用磁片區檔案系統 (CsvFS) 是
彈性檔案系統 (ReFS) 是
 

範例

如需範例，請參閱 建立和使用暫存檔案。

注意

fileapi.h 標頭會將 GetTempPath 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

需求

   
最低支援的用戶端 Windows XP [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2003 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 fileapi.h (包含 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

檔案管理功能

GetTempFileName

符號連結