Repository.WriteToDiagnosticsLog

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

Syntax

• WriteToDiagnosticsLog(message As String , entrytype As XFRACASDiagnosticEntryType, commentAs String)

Parameters

message: The message that should be displayed in the diagnostics log for the diagnostics entry type

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

exObject: The object that can be written into the diagnostics log.

comment: Optional comment that can be written into the diagnostics log.

XFRACASDiagnosticsEntryType: The type of diagnostics entry

Usage Example

Code Block

' Declare a new repository connection class. 
Private WithEvents MyRepository As New Repository
' Connect to the Synthesis repository. 
Dim Success As Boolean = False
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
' Get the list of XFRACAS Entities in the current project in the connected repository. 
Dim ListOfXFRACASEntities() As NameIdPair
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()
' Import the XML file into the entity desired.  In this example, the first entity is used. 
Dim ImportXMLSystemID As Integer
ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID,   XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")
' Process the imported file. 
MyRepository.ProcessXfracasImports()
' Create place to see where code is breaking instead of writing to your own logfile 
MyRepository.WriteToDiagosticsLog(Diagnostics Message TextAs String, ByVal entryType As XFRACASDiagnosticsEntryType.4)

Reformatted Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

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

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

       Dim ListOfXFRACASEntities() As NameIdPair
       ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()

Import the XML file into the entity desired. In this example, the first entity is used.

       Dim ImportXMLSystemID As Integer
       ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")

Process the imported file.

       MyRepository.ProcessXfracasImports()

Create place to see where code is breaking instead of writing to your own logfile

       MyRepository.WriteToDiagosticsLog(ByVal Diagnostics Message As String, ByVal entryType As XFRACASDiagnosticsEntryType.4)