getFileAttributesA 函式 (fileapi.h)

發行項
06/02/2023

擷取指定檔案或目錄的檔案系統屬性。

若要取得更多屬性資訊，請使用 GetFileAttributesEx 函式。

若要以交易作業的形式執行此作業，請使用 GetFileAttributesTransacted 函式。

語法

DWORD GetFileAttributesA(
  [in] LPCSTR lpFileName
);

參數

[in] lpFileName

檔案或目錄的名稱。

根據預設，名稱限制為MAX_PATH個字元。若要將此限制延伸至 32，767 寬字元，請在路徑前面加上「\\？\」。如需詳細資訊，請參閱命名檔案、路徑與命名空間。

提示

從 Windows 10 版本 1607 開始，您可以選擇移除MAX_PATH限制，而不需在前面加上「\\？\」。如需詳細資訊，請參閱命名檔案、路徑和命名空間的一節。

傳回值

如果函式成功，傳回值會包含指定檔案或目錄的屬性。如需屬性值及其描述的清單，請參閱檔案屬性常數。

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

備註

在掛接資料夾的目錄上呼叫 GetFileAttributes 時，它會傳回目錄的檔案系統屬性，而不是掛接資料夾與目錄相關聯之磁片區中根目錄的屬性。若要取得相關聯磁片區的檔案屬性，請呼叫 GetVolumeNameForVolumeMountPoint 以取得相關聯磁片區的名稱。然後在 呼叫 GetFileAttributes時使用產生的名稱。結果是相關聯磁片區上根目錄的屬性。

如果您呼叫網路共用的 GetFileAttributes ，函式會失敗，而且 GetLastError 會傳回 ERROR_BAD_NETPATH。您必須指定該共用上子資料夾的路徑。

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

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

符號連結行為：如果路徑指向符號連結，函式會傳回符號連結的屬性。

交易作業

如果檔案在交易中開啟以供修改，則除非認可交易，否則沒有其他執行緒可以開啟檔案以進行修改。因此，如果交易的執行緒先開啟檔案，任何後續嘗試在認可交易之前修改檔案的執行緒會收到共用違規。如果非交易執行緒在交易執行緒之前修改檔案，而且當交易嘗試開啟檔案時，檔案仍會開啟，則交易會收到錯誤 ERROR_TRANSACTIONAL_CONFLICT。

範例

如需範例，請參閱擷取和變更檔案屬性。

注意

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

規格需求


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