CreateLogContainerScanContext 函式 (clfsw32.h)

發行項
02/23/2024

建立掃描內容以搭配 ScanLogContainers 使用，以列舉與記錄相關聯的所有記錄容器，並執行第一次掃描。

語法

CLFSUSER_API BOOL CreateLogContainerScanContext(
  [in]                HANDLE             hLog,
  [in]                ULONG              cFromContainer,
  [in]                ULONG              cContainers,
  [in]                CLFS_SCAN_MODE     eScanMode,
  [in, out]           PCLFS_SCAN_CONTEXT pcxScan,
  [in, out, optional] LPOVERLAPPED       pOverlapped
);

參數

[in] hLog

從 CreateLogFile 取得之記錄的句柄，具有掃描記錄容器的許可權。

檔案可以是專用或多任務記錄檔。

[in] cFromContainer

要啟動掃描的容器。

此參數是相對於記錄中容器數目的序數。

[in] cContainers

要配置的 CreateLogContainerScanContextCLFS_CONTAINER_INFORMATION 結構數目。

此號碼是每個掃描呼叫所掃描的容器數目，因此呼叫端知道當傳回的容器數目小於此值時，掃描已完成。

結束時，CLFS_CONTAINER_INFORMATION 結構的系統配置數位指標會放在用戶端配置CLFS_SCAN_CONTEXT結構的 pinfoContainer 成員中。這個成員是由 pcxScan 參數 (指向，也就是 “pcxScan-pinfoContainer>[]”) ，而陣列中的實際結構數目會放在 “pcxScan-cContainersReturned>”。

客戶端必須呼叫 ScanLogContainers ，並將 eScanMode 參數設定為 CLFS_SCAN_CLOSE ，以便釋放此陣列;否則，記憶體流失結果。

[in] eScanMode

要掃描容器的模式。

您可以在下列任一模式中掃描容器。

值	意義
CLFS_SCAN_INIT	從容器清單中的第一個容器初始化或重新初始化掃描。此模式會初始化容器內容，並傳回 cContainers 指定的第一組容器描述元。
CLFS_SCAN_FORWARD	傳回 cContainers 指定的第一組容器。
CLFS_SCAN_BACKWARD	傳回 cContainers 指定的最後一組容器。

[in, out] pcxScan

用戶端配置的 CLFS_SCAN_CONTEXT 結構的指標，可在用戶端掃描專用記錄的記錄容器時，接收可傳遞至 ScanLogContainers 函式的掃描內容。

[in, out, optional] pOverlapped

異步操作所需的重疊結構指標。

如果未使用異步操作，此參數可以是 NULL 。

傳回值

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

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

下列清單會識別可能的錯誤碼：

備註

完成掃描之後，客戶端必須再次呼叫 ScanLogContainers ，並將 eScanMode 參數設定為 CLFS_SCAN_CLOSE ，以便釋放系統配置的 CLFS_CONTAINER_INFORMATION 結構數位;否則，記憶體流失結果。

範例

如需使用此函式的範例，請參閱列舉記錄容器。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 R2 [僅限傳統型應用程式]
目標平台	Windows
標頭	clfsw32.h
程式庫	Clfsw32.lib
Dll	Clfsw32.dll