nf-clfsw32-truncatelog.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:clfsw32.TruncateLog	TruncateLog function (clfsw32.h)	Truncates the log. The function sets the end of the log to the specified value.	TruncateLog TruncateLog function [Files] clfsw32/TruncateLog fs.truncatelog	fs\truncatelog.htm	fs	76ef1a01-ba5c-4419-ac2f-4ba53dcc5bc4	12/05/2018	TruncateLog, TruncateLog function [Files], clfsw32/TruncateLog, fs.truncatelog	clfsw32.h		Windows	Windows Vista [desktop apps only]	Windows Server 2003 R2 [desktop apps only]										Clfsw32.lib	Clfsw32.dll		Windows			19H1	TruncateLog clfsw32/TruncateLog	c++	APIRef kbSyntax	DllExport	Clfsw32.dll	TruncateLog

TruncateLog function

-description

Truncates the log. The function sets the end of the log to the specified value.

-parameters

-param pvMarshal [in]

A pointer to the opaque marshaling context that is allocated by calling the CreateLogMarshallingArea function.

-param plsnEnd [in]

A pointer to a CLFS_LSN structure that specifies the new end of a log.

The LSN must be between the base log sequence number (LSN) of the log and the last LSN of the log.

-param lpOverlapped [in, out, optional]

Reserved. Set Reserved to NULL.

-returns

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. The following list identifies the possible error codes:

-remarks

If the volume sector size is greater than 512 bytes, TruncateLog returns ERROR_NOT_SUPPORTED.

-see-also

CLFS_LSN

Common Log File System Functions

OVERLAPPED