Repository.WriteToDiagnosticsLog

This subroutine adds diagnostic information into the diagnostics log. There are two methods that can be used. Both are shown.

This method is an overloaded method which means the same signature will accept different sets of arguments. Both available methods are shown separately.

First Available Method

Writes a message to the diagnostics log

Syntax

• WriteToDiagnosticsLog(message As String , entrytype As XFRACASDiagnosticEntryType)

Parameters

message: Message to write to the diagnostics log

entryType: The type of diagnostics entry type, specified as XFRACASDiagnosticsEntryType

Second Available Method

Writes exception information to the diagnostics log

Syntax

• WriteToDiagnosticsLog(exObject As System.Exception , entrytype As XFRACASDiagnosticEntryType, Optional commentAs String)

Parameters

exObject: Represents an error that occurs during application execution

entryType: The type of diagnostics entry type, specified as XFRACASDiagnosticsEntryType

comment: Optional comment to write to the diagnostics log

Usage Example

Code Block

' Connect to the Synthesis repository. 
Dim Success As Boolean = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 ' Get the list of XFRACAS Entities in the current project in the connected repository. 
  If success Then
           Try
               Dim ListOfXFRACASEntities() As SynthesisAPI.NameIdPair= MyRepository.GetAllXFRACASEntities()
               For i As Integer = 0 To ListOfXFRACASEntities.GetUpperBound(0)
                   MessageBox.Show(ListOfXFRACASEntities(i).Name)
               Next
          ' Write error message to diagnostics log 
           Catch ex As Exception
               MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.XFRACASDiagnosticsEntryType.Error, "Reading Entities")
           End Try
  Else
          ' Write warning message to diagnostics log 
           MyRepository.WriteToDiagosticsLog("Unable to connect to repository", SynthesisAPI.XFRACASDiagnosticsEntryType.Warning)
  End If

Reformatted Usage Example

Connect to the Synthesis repository.

       Dim Success As Boolean = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Start "If" Statement

If success Then
            

Start "try" Statement

Try

Get the list of XFRACAS Entities in the current project in the connected repository.

       Dim ListOfXFRACASEntities() As SynthesisAPI.NameIdPair= MyRepository.GetAllXFRACASEntities()
               For i As Integer = 0 To ListOfXFRACASEntities.GetUpperBound(0)
                   MessageBox.Show(ListOfXFRACASEntities(i).Name)

Start diagnostics messages

        Next

Write error message to diagnostics log

Catch ex As Exception
               MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.XFRACASDiagnosticsEntryType.Error, "Reading Entities")

End "try" Statement

  End Try
Else

Write warning message to diagnostics log

MyRepository.WriteToDiagosticsLog("Unable to connect to repository", SynthesisAPI.XFRACASDiagnosticsEntryType.Warning)
  End If