lockFile 函式 (fileapi.h)

發行項
08/23/2023

藉由呼叫進程鎖定指定的檔案以進行獨佔存取。

若要指定其他選項，例如建立共用鎖定或封鎖失敗作業，請使用 LockFileEx 函式。

語法

BOOL LockFile(
  [in] HANDLE hFile,
  [in] DWORD  dwFileOffsetLow,
  [in] DWORD  dwFileOffsetHigh,
  [in] DWORD  nNumberOfBytesToLockLow,
  [in] DWORD  nNumberOfBytesToLockHigh
);

參數

[in] hFile

檔案的控制碼。必須使用 GENERIC_READ 或 GENERIC_WRITE 存取權限來建立檔案控制代碼。如需詳細資訊，請參閱檔案安全性和存取權限。

[in] dwFileOffsetLow

檔案中應該開始鎖定之起始位元組位移的低序 32 位。

[in] dwFileOffsetHigh

檔案中應該開始鎖定之起始位元組位移的高序 32 位。

[in] nNumberOfBytesToLockLow

要鎖定之位元組範圍長度的低順序 32 位。

[in] nNumberOfBytesToLockHigh

要鎖定之位元組範圍長度的高階 32 位。

傳回值

如果函式成功，傳回值為非零 (TRUE) 。

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

備註

如果 LockFile 的呼叫同步完成，完成專案可能不會在完成埠與檔案控制代碼相關聯時排入佇列。

UnlockFile函式會解除鎖定LockFile鎖定的檔案區域。

鎖定檔案的區域可讓鎖定進程使用此檔案控制碼獨佔存取指定區域的執行緒。如果檔案控制碼是由鎖定進程所建立的進程所繼承，則子進程不會被授與鎖定區域的存取權。如果鎖定程式第二次開啟檔案，它就無法透過這個第二個控制碼存取指定的區域，直到解除鎖定區域為止。

鎖定檔案的區域不會防止從對應的檔案檢視讀取或寫入。

您可以鎖定超出目前檔案結尾的位元組。這很適合用來協調將記錄新增至檔案結尾。

獨佔鎖定無法與檔案的現有鎖定區域重迭。如需詳細資訊，請參閱 LockFileEx。

如果 LockFile 無法鎖定檔案的區域，則會立即傳回零。它不會封鎖。若要發出在取得鎖定之前會封鎖的檔案鎖定要求，請使用 LockFileEx 而不使用 LOCKFILE_FAIL_IMMEDIATELY 旗標。

如果進程以鎖定的檔案部分終止，或關閉具有未完成鎖定的檔案，則鎖定會由作業系統解除鎖定。不過，作業系統解除鎖定所需的時間取決於可用的系統資源。因此，建議您的程式在終止時，明確地解除鎖定它鎖定的所有檔案。如果未這麼做，如果作業系統尚未解除鎖定這些檔案，存取這些檔案可能會遭到拒絕。

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

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

範例

如需範例，請參閱將一個檔案附加至另一個檔案。

需求


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