Edit

TxfLogReadRecords function (txfw32.h)

  • Article

[Microsoft strongly recommends developers utilize alternative means to achieve your application’s needs. Many scenarios that TxF was developed for can be achieved through simpler and more readily available techniques. Furthermore, TxF may not be available in future versions of Microsoft Windows. For more information, and alternatives to TxF, please see Alternatives to using Transactional NTFS.]

Reads the redo records from the log.

Syntax

BOOL TxfLogReadRecords(
  [in]  PVOID  TxfLogContext,
  [in]  ULONG  BufferLength,
  [out] PVOID  Buffer,
  [out] PULONG BytesUsed,
  [out] PULONG RecordCount
);

Parameters

[in] TxfLogContext

A pointer to the context.

[in] BufferLength

The size of the output buffer, in bytes.

[out] Buffer

A pointer to the buffer that receives the records. For more information, see TXF_LOG_RECORD_BASE.

[out] BytesUsed

The number of bytes written to the output buffer.

[out] RecordCount

The number of records written to the output buffer.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. Possible error codes include the following.

Return code Description
ERROR_INVALID_HANDLE
 The replication context is invalid.
ERROR_MORE_DATA
 Some of the available records were copied into the buffer. Call this function again to retrieve the rest of the records.
ERROR_INSUFFICIENT_BUFFER
 The buffer is not large enough to contain even one record. If BytesUsed is nonzero, then there was enough space to copy the TXF_LOG_RECORD_BASE structure, which indicates the required buffer size to read the next complete record.
ERROR_FILE_CORRUPT
 The format of the log file being processed is unrecognized.

Requirements

Requirement Value
Minimum supported client Windows Vista with SP1 [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header txfw32.h
Library TxfW32.lib
DLL TxfW32.dll

See also

TXF_LOG_RECORD_BASE