Repository.XFRACAS.WriteExceptionToDiagnosticsLog

Member of: SynthesisAPI9.Repository

Writes exception information to the XFRACAS diagnostics log. (VB.NET only)

Syntax

.WriteExceptionToDiagnosticsLog (exObject, entryType, comment)

Parameters

exObject

Required. Exception. Represents the error that occurred during application execution.

entryType

Required. The XFRACAS diagnostics type. Can be any XFRACASDiagnosticsEntryType enumeration.

comment

Optional. String. The text to write to the XFRACAS diagnostics log.

Example

The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. It assumes that the repository has existing connections to XFRACAS entities.

VB.NET

 'Connect to the Synthesis repository. The following code 
 'assumes that a file called "RSRepository1.rsr10" exists in the C: drive. 
  Dim MyRepository As New Repository
  Dim Success As Boolean
  Success = MyRepository.ConnectToRepository ("C:\RSRepository1.rsr10")

 'Record a message to diagnostic log if the connection to the repository is successful. 
  If Success Then
  MyRepository.XFRACAS.WriteMessageToDiagnosticsLog("Successfully connected to repository", XFRACASDiagnosticsEntryType.Information)

  'Get a list of all XFRACAS entities connected to the repository.  
  Try
     Dim ListOfXFRACASEntities() As NameIdPair
     ListofXFRACASEntities = MyRepository.XFRACAS.GetAllXFRACASEntities

     Dim i As Integer
     For i = 0 To ListOfXFRACASEntities.GetUpperBound(0)
           MessageBox.Show(ListOfXFRACASEntities(i).Name)
     Next 

  Catch Ex As Exception
     'Write error message to diagnostics log. 
     MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, "Reading Entities")

  End Try
End If