DavGetTheLockOwnerOfTheFile 函式 (davclnt.h)
傳回 WebDAV 伺服器上鎖定之檔案的檔案鎖定擁有者。
語法
DWORD DavGetTheLockOwnerOfTheFile(
[in] LPCWSTR FileName,
[out, optional] PWSTR LockOwnerName,
[in, out] PULONG LockOwnerNameLengthInBytes
);
參數
[in] FileName
Null終止 Unicode 字串的指標,其中包含 WebDAV 伺服器上鎖定的檔案名。 此字串必須是下列其中一種格式:
- \\server\path\filename
- drive:\filename
[out, optional] LockOwnerName
呼叫端配置的緩衝區指標,可接收檔案鎖定的擁有者名稱。 這個參數是選擇性的,而且可以是 Null。 如果是 Null, LockOwnerNameLengthInBytes 參數必須在輸入上指向零。
[in, out] LockOwnerNameLengthInBytes
輸入上變數的指標會指定 LockOwnerName 參數指向之緩衝區的大小上限,以 Unicode 字元為單位。 如果函式成功,在輸出時,變數會收到複製到緩衝區的字元數。 如果函式因ERROR_INSUFFICIENT_BUFFER而失敗,則變數在輸出時會收到儲存鎖定擁有者名稱所需的字元數,包括終止 的 Null 字元。
傳回值
如果函式成功,傳回值會ERROR_SUCCESS。
如果函式失敗,傳回值是 系統錯誤碼,例如下列其中一個值。
傳回碼 | 描述 |
---|---|
|
LockOwnerName參數指向的緩衝區不夠大,無法儲存鎖定擁有者名稱。 |
|
一或多個參數值無效。 例如,如果 FileName 參數是 Null 指標,則會傳回這個錯誤碼。 |
備註
如果 WebDAV 伺服器上檔案的 CreateFile 之類的函式呼叫失敗,並ERROR_LOCK_VIOLATION,您可以使用 DavGetTheLockOwnerOfTheFile 函式來判斷檔案鎖定的擁有者。
若要取得 LockOwnerName 緩衝區的必要緩衝區長度,請呼叫 DavGetTheLockOwnerOfTheFile 並將 LockOwnerName 設為 Null ,並將 LockOwnerNameLengthInBytes 設定為零。 傳回值ERROR_INSUFFICIENT_BUFFER,而且在輸出時 ,LockOwnerNameLengthInBytes 參數會收到所需的緩衝區長度。
需求
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | davclnt.h |
程式庫 | Davclnt.lib |
Dll | Davclnt.dll |