Repository.XFRACAS.WriteExceptionToDiagnosticsLog: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 25: Line 25:
         '{{APIComment|Write error message to diagnostics log}}
         '{{APIComment|Write error message to diagnostics log}}
     {{APIPrefix|Catch}} ex {{APIPrefix|As}} Exception
     {{APIPrefix|Catch}} ex {{APIPrefix|As}} Exception
         MyRepository.[[Editing Repository.WriteToDiagnosticsLog(System.Exception, XFRACASDiagnosticEntryType, String)|WriteToDiagosticsLog]](ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
         MyRepository.[[Repository.WriteToDiagnosticsLog(System.Exception, XFRACASDiagnosticEntryType, String)|WriteToDiagosticsLog]](ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
     {{APIPrefix|End Try}}
     {{APIPrefix|End Try}}
  {{APIPrefix|Else}}
  {{APIPrefix|Else}}
         '{{APIComment|Write warning message to diagnostics log}}
         '{{APIComment|Write warning message to diagnostics log}}
         MyRepository.[[Editing Repository.WriteToDiagnosticsLog(System.Exception, XFRACASDiagnosticEntryType, String)|WriteToDiagosticsLog]]("Unable to connect to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Warning)
         MyRepository.[[Repository.WriteToDiagnosticsLog(System.Exception, XFRACASDiagnosticEntryType, String)|WriteToDiagosticsLog]]("Unable to connect to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Warning)
  {{APIPrefix|End If}}
  {{APIPrefix|End If}}

Revision as of 19:45, 28 April 2014


Writes exception information to the diagnostics log

Syntax

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