clfsw32.h header

This header is used by Data Access and Storage. For more information, see:

• Data Access and Storage

clfsw32.h contains the following programming interfaces:

Functions

AddLogContainer Adds a container to the physical log that is associated with the log handle�if the calling process has write access to the .blf file and the ability to create files in the target directory of the container.
AddLogContainerSet Adds multiple log containers to the physical log that is associated with the log handle�if the calling process has access to the log handle.
AdvanceLogBase Advances the base log sequence number (LSN) of a log stream to the specified LSN.
AlignReservedLog Calculates the sector-aligned reservation size for a set of reserved records.
AllocReservedLog Allocates sector-aligned space for a set of reserved records.
CloseAndResetLogFile Resets the log file and then shuts the log.
CreateLogContainerScanContext Creates a scan context to use with ScanLogContainers to enumerate all log containers that are associated with a log, and performs the first scan.
CreateLogFile Creates or opens a log.
CreateLogMarshallingArea Creates a marshaling area for a log, and when successful it returns a marshaling context. Before creating a marshaling area, the log must have at least one container.
DeleteLogByHandle Marks the specified log for deletion. The log is actually deleted when all handles, marshaling areas, and read contexts to the log are closed. If the log is a physical log, its underlying containers are deleted.
DeleteLogFile Marks a log for deletion. The log is actually deleted when all handles, marshaling areas, and read contexts to the log are closed. If the log is a physical log, its underlying containers are deleted.
DeleteLogMarshallingArea Deletes a marshaling area that is created by a successful call to CreateLogMarshallingArea.
DumpLogRecords Scans a specified log; filters log records based on record type; and places the records in an output file stream that the caller opens.
FlushLogBuffers Forces all records appended to this marshaling area to be flushed to disk.
FlushLogToLsn Forces all records appended to this marshaling area up to the record with the specified log sequence number (LSN) to be flushed to the disk. More records than specified may be flushed during this operation.
FreeReservedLog Reduces the number of reserved log records in a marshaling area made by calling ReserveAndAppendLog, ReserveAndAppendLogAligned, or AllocReservedLog.
GetLogContainerName Retrieves the full path name of the specified container.
GetLogFileInformation Returns a buffer that contains metadata about a specified log and its current state, which is defined by the CLFS_INFORMATION structure.
GetLogIoStatistics Retrieves log I/O statistics for a dedicated or multiplexed log that is associated with the specified handle.
GetNextLogArchiveExtent Retrieves the next set of archive extents in a log archive context.
LsnBlockOffset Returns the sector-aligned block offset that is contained in the specified LSN.
LsnContainer Retrieves the logical container ID that is contained in a specified LSN.
LsnCreate Creates a log sequence number (LSN), given a container ID, a block offset, and a record sequence number.
LsnRecordSequence Retrieves the record sequence number that is contained in a specified LSN.
PrepareLogArchive Prepares a physical log for archival.
ReadLogArchiveMetadata Copies a range of the archive view of the metadata to the specified buffer.
ReadLogRecord Initiates a sequence of reads from a specified log sequence number (LSN) in one of three modes, and returns the first of the specified log records and a read context.
ReadLogRestartArea Returns the last restart area that is written successfully to the log associated with the marshaling area of WriteLogRestartArea.
ReadNextLogRecord Reads the next record in a sequence that is initiated by a call to ReadLogRecord or ReadLogRestartArea.
ReadPreviousLogRestartArea Reads the previous log restart area that is relative to the current restart record specified in the read context, pvReadContext. This read context is the one previously created by a call to ReadLogRestartArea.
RemoveLogContainer Removes one container from a log that is associated with a dedicated or multiplexed log handle.
RemoveLogContainerSet Removes multiple containers from a log that is associated with a dedicated or multiplexed log handle.
ReserveAndAppendLog Reserves space for log buffers, or appends a log record to the log, or does both. The function is atomic.
ReserveAndAppendLogAligned Reserves space for log buffers, or appends a log record to the log, or both.
ScanLogContainers Enumerates log containers. Call this function repeatedly to iterate over all log containers.
SetEndOfLog This function has been deprecated. Use TruncateLog instead.
SetLogArchiveMode Enables or disables log archive support for a specified log.
SetLogArchiveTail Sets the last archived log sequence number (LSN) or archive tail of an archivable log.
TerminateLogArchive Deallocates system resources that are allocated originally for a log archive context by PrepareLogArchive.
TerminateReadLog Terminates a read context. This function frees system-allocated resources associated with the specified read context. Do not attempt to read log records after calling this function; you will receive indeterminate results.
TruncateLog Truncates the log. The function sets the end of the log to the specified value.
ValidateLog Validates the consistency of the log metadata and data before log archive and after log restore.
WriteLogRestartArea Appends a new client restart area to a log, and optionally advances the base log sequence number (LSN) of the log.