SetFileShortNameA 函式（winbase.h）

設定指定檔案的簡短名稱。檔案必須位於NTFS檔系統磁碟區上。

語法

BOOL SetFileShortNameA(
  [in] HANDLE hFile,
  [in] LPCSTR lpShortName
);

[in] hFile

檔案的句柄。檔案必須以 GENERIC_ALL 訪問許可權或 GENERIC_WRITE|DELETE開啟，並使用 FILE_FLAG_BACKUP_SEMANTICS 檔案屬性開啟。

[in] lpShortName

字串的指標，指定檔案的簡短名稱。

如果 hFile 參數指定的檔案存在，則指定空的（零長度）字串將會移除簡短的檔名。如果簡短檔名不存在，則函式不會執行任何動作並傳回成功。

Windows Server 2008、Windows Vista、Windows Server 2003 和 Windows XP：不支援此行為。參數必須包含一或多個字元的有效字串。

如果函式成功，則傳回值為非零值。

如果函式失敗，傳回值為零。若要取得擴充的錯誤資訊，請呼叫 GetLastError。 GetLastError 可能會傳回此函式特有的下列其中一個錯誤碼。

傳回碼	描述
ERROR_ALREADY_EXISTS	指定的簡短名稱不是唯一的。
ERROR_INVALID_PARAMETER	指定的檔案已以區分大小寫模式開啟，或指定的簡短名稱無效。

此函式的呼叫端必須具有 SE_RESTORE_NAME 許可權。如需詳細資訊，請參閱以特殊許可權執行。

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

SMB 3.0 不支援具有持續可用性功能的共用簡短名稱。 CsvF 不建議使用簡短名稱。

注意

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