Repository.WriteToDiagnosticsLog: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 29: Line 29:


   
   
  '{{APIComment|Connect to the Synthesis repository.}}
'{{APIComment|Connect to the Synthesis repository.}}
  {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")
  {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")
  '{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
'{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
  {{APIPrefix|If}} success {{APIPrefix|Then}}
  {{APIPrefix|If}} success {{APIPrefix|Then}}
  {{APIPrefix|Try}}
    {{APIPrefix|Try}}
    {{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} SynthesisAPI.[[NameIdPair Class|NameIdPair]]= MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
        {{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} SynthesisAPI.[[NameIdPair Class|NameIdPair]]= MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
    {{APIPrefix|For}} i {{APIPrefix|As Integer}} = 0 {{APIPrefix|To}} ListOfXFRACASEntities.GetUpperBound(0)
        {{APIPrefix|For}} i {{APIPrefix|As Integer}} = 0 {{APIPrefix|To}} ListOfXFRACASEntities.GetUpperBound(0)
                     MessageBox.Show(ListOfXFRACASEntities(i).Name)
                     MessageBox.Show(ListOfXFRACASEntities(i).Name)
    {{APIPrefix|Next}}
        {{APIPrefix|Next}}
  '{{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.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]](ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
        MyRepository.[[Repository.WriteToDiagnosticsLog|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.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]]("Unable to connect to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Warning)
        MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]]("Unable to connect to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Warning)
  {{APIPrefix|End If}}
  {{APIPrefix|End If}}

Revision as of 17:07, 28 April 2014



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


First Available Method

Writes a message to the diagnostics log

Syntax

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

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