Empty the database, discarding all records it contains.

Namespace:  BerkeleyDB
Assembly:  libdb_dotnet48 (in libdb_dotnet48.dll) Version: 4.8.24.0

Syntax

C#
public uint Truncate(
	Transaction txn
)
Visual Basic (Declaration)
Public Function Truncate ( _
	txn As Transaction _
) As UInteger
Visual C++
public:
unsigned int Truncate(
	Transaction^ txn
)

Parameters

txn
Type: BerkeleyDB..::.Transaction
txn is a Transaction object returned from BeginTransaction()()(); if the operation is part of a Berkeley DB Concurrent Data Store group, txn is a handle returned from BeginCDSGroup()()(); otherwise null.

Return Value

The number of records discarded from the database.

Remarks

If txn is null and the operation occurs in a transactional database, the operation will be implicitly transaction protected.

See Also