Suppl::SetTransMode

Sets the transaction mode.

void SetTransMode (
enum eTransMode eTransMode
)

Parameters

eTransMode

[in] A value of the 'eTransMode' enumeration.

Remarks

A transaction is only valid within one Suppl-interface, you cannot use a transaction to modify multiple interfaces simultaneously.

See Also

CreateSuppl

Samples

C++

bool bOK = true, bContinue = true;

// Start the transaction
pSuppl->SetTransMode (tmBegin);

while (bContinue)
{
    // Perform some actions on the file, saving the result in bOK
}

if (bOK)        // If no errors occured, commit the transaction, saving all changes to disk.
    pSuppl->SetTransMode (tmCommit);
else            // If errors occured, roll back the transaction, discarding all changes.
    pSuppl->SetTransMode (tmRollBack);

bool bOK = true, bContinue = true;

// Start the transaction
oSuppl.SetTransMode (eTransMode.tmBegin);

while (bContinue)
{
    // Perform some actions on the file, saving the result in bOK
}

if (bOK)        // If no errors occured, commit the transaction, saving all changes to disk.
    oSuppl.SetTransMode (eTransMode.tmCommit);
else            // If errors occured, roll back the transaction, discarding all changes.
    oSuppl.SetTransMode (eTransMode.tmRollBack);

VBS

Dim bOK, bContinue
bOK = True
bContinue = True

' Start the transaction
Call oSuppl.SetTransMode(tmBegin)

While bContinue
    ' Perform some actions on the file, saving the result in bOK
Wend

If bOK Then        ' If no errors occured, commit the transaction, saving all changes to disk.
    Call oSuppl.SetTransMode(tmCommit)
Else            ' If errors occured, roll back the transaction, discarding all changes.
    Call oSuppl.SetTransMode(tmRollBack)
End If

VB.NET

Dim bOK, bContinue As Boolean
bOK = True
bContinue = True

' Start the transaction
oSuppl.SetTransMode(eTransMode.tmBegin)

While bContinue
    ' Perform some actions on the file, saving the result in bOK
End While

If bOK Then        ' If no errors occured, commit the transaction, saving all changes to disk.
    oSuppl.SetTransMode(eTransMode.tmCommit)
Else            ' If errors occured, roll back the transaction, discarding all changes.
    oSuppl.SetTransMode(eTransMode.tmRollBack)
End If