WriteLogRestartArea 函式 (clfsw32.h)
將新的用戶端重新啟動區域附加至記錄檔,並選擇性地將基底記錄序號 (LSN) 記錄檔。
成功寫入磁碟之後,記錄的最後一個 LSN 會變更為附加重新啟動記錄的 LSN。 通常 ,WriteLogRestartArea 是由定期儲存已知良好狀態的應用程式使用,而重新啟動區域包含現有記錄記錄鏈結的 LSN。
語法
CLFSUSER_API BOOL WriteLogRestartArea(
[in, out] PVOID pvMarshal,
[in] PVOID pvRestartBuffer,
[in] ULONG cbRestartBuffer,
[in, optional] PCLFS_LSN plsnBase,
[in] ULONG fFlags,
[out, optional] PULONG pcbWritten,
[out, optional] PCLFS_LSN plsnNext,
[in, out, optional] LPOVERLAPPED pOverlapped
);
參數
[in, out] pvMarshal
使用 CreateLogMarshallingArea 函式所配置之封送處理內容的指標。
[in] pvRestartBuffer
包含重新啟動數據的緩衝區指標。
[in] cbRestartBuffer
pvRestartBuffer 的大小,以位元組為單位。
[in, optional] plsnBase
CLFS_LSN 結構的指標,指定成功寫入重新啟動區域之後記錄檔的新基底 LSN。
這個值不能超出使用中記錄的範圍。 它至少必須是目前基底 LSN 的值,而且不能大於 lastLSN 參數中從最新對 ReserveAndAppendLog 呼叫傳回的 LSN。 如果您省略這個選擇性參數,基底 LSN 不會變更。
[in] fFlags
指定此函式行為的旗標。
可以合併下列一或多個值。
值 | 意義 |
---|---|
|
不指派任何旗標。 |
|
使用封送處理區域中保留的空間來附加當前記錄。 |
[out, optional] pcbWritten
變數的指標,接收作業完成時所寫入的位元組數目。
[out, optional] plsnNext
CLFS_LSN 結構的指標,指定寫入之重新啟動區域的 LSN。
[in, out, optional] pOverlapped
重疊結構的指標。
如果未使用異步操作,這個參數可以是 NULL 。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
下列清單會識別可能的錯誤碼:
備註
WriteLogRestartArea 會同時排清所有目前緩衝的記錄檔記錄和記錄元數據的排清。
例如,如果用戶端在建立以支援異步操作 (的記錄檔上呼叫 WriteLogRestartArea,例如,如果 CreateLogFile 的 fFlagsAndAttributes 參數設定為 FILE_FLAG_OVERLAPPED) ,用戶端就必須在 WriteLogRestartArea的 pOverlapped 參數中提供有效的 OVERLAPPED 結構的指標。
然後,如果 WriteLogRestartArea 失敗並出現 錯誤ERROR_IO_PENDING,則有效的讀取內容的指標會放在 ppvReadContext 參數所指向的變數中。
若要完成呼叫,客戶端應該使用 GetOverlappedResult 或其中一個同步 處理等候函式,將其執行與重疊 I/O 作業延遲完成同步處理。 如需詳細資訊,請參閱 同步處理和重疊的輸入和輸出。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 R2 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | clfsw32.h |
程式庫 | Clfsw32.lib |
Dll | Clfsw32.dll |