This documentation is archived and is not being maintained.

Clerk Class

Writes records of transactional actions to a log.

Namespace:  System.EnterpriseServices.CompensatingResourceManager
Assembly:  System.EnterpriseServices (in System.EnterpriseServices.dll)

'Declaration
Public NotInheritable Class Clerk
'Usage
Dim instance As Clerk

Each clerk is associated with a compensator, which is called back to perform actions during the two-phase commit of the transaction.

The following code example demonstrates the use of this class.

' A CRM Worker
<Transaction()>  _
Public Class Account
    Inherits ServicedComponent

    ' A data member for the account file name. 
    Private filename As String 


    Public Property Filenam() As String 
        Get 
            Return Filename
        End Get 
        Set(ByVal value As String)
            filename = Value
        End Set 
    End Property 


    ' A boolean data member that determines whether to commit or abort the transaction. 
    Private commit As Boolean 


    Public Property AllowCommit() As Boolean  
        Get 
            Return commit
        End Get 
        Set
            commit = value
        End Set 
    End Property 




    ' Debit the account,  
    Public Sub DebitAccount(ByVal ammount As Integer) 

        ' Create a new clerk using the AccountCompensator class. 
        Dim clerk As New Clerk(GetType(AccountCompensator), "An account transaction compensator", CompensatorOptions.AllPhases)
        ' Create a record of previous account status, and deliver it to the clerk. 
        Dim balance As Integer = AccountManager.ReadAccountBalance(Filenam)

        Dim record(1) As [Object]
        record(0) = filename
        record(1) = balance

        clerk.WriteLogRecord(record)
        clerk.ForceLog()
        ' Perform the transaction
        balance -= ammount
        AccountManager.WriteAccountBalance(filename, balance)

        ' Commit or abort the transaction  
        If commit Then
            ContextUtil.SetComplete()
        Else
            ContextUtil.SetAbort()
        End If 
    End Sub 'DebitAccount ' 

End Class 'Account

The following code example demonstrates the corresponding Compensator class.

Imports System



Public Class CrmClient


    Public Shared Sub Main() 

        ' Create a new account object. The object is created in a COM+ server application. 
        Dim account As New Account()

        ' Transactionally debit the account. 
        Try
            account.Filenam = System.IO.Path.GetFullPath("JohnDoe")
            account.AllowCommit = True
            account.DebitAccount(3)
        Finally
            account.Dispose()
        End Try 

    End Sub 'Main 
End Class 'CrmClient

System.Object
  System.EnterpriseServices.CompensatingResourceManager.Clerk

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: