Repository.XFRACAS.WriteExceptionToDiagnosticsLog: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 16: Line 16:
  '{{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}}
             MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Information)  
             MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Information)  

Revision as of 21:22, 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
           MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.XFRACASDiagnosticsEntryType.Information) 
       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
    End If