Repository.XFRACAS.WriteExceptionToDiagnosticsLog: Difference between revisions

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


= Usage Example =
= Usage Example =
{{APIComment|Code Block}}
  {{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.XFRACAS.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Information)  
     {{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.XFRACAS.[[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)
Line 26: Line 23:
     {{APIPrefix|Catch}}ex{{APIPrefix|As}}Exception
     {{APIPrefix|Catch}}ex{{APIPrefix|As}}Exception
         {{APIComment|'Write error message to diagnostics log}}
         {{APIComment|'Write error message to diagnostics log}}
           MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
           MyRepository.XFRACAS.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
     {{APIPrefix|End Try}}
     {{APIPrefix|End Try}}
  {{APIPrefix|End If}}
  {{APIPrefix|End If}}

Revision as of 15:50, 27 May 2015


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

 'Connect to the Synthesis repository. 
DimSuccessAs Boolean= MyRepository.ConnectToRepository("RepositoryFileNamePath")
 'Get the list of XFRACAS Entities in the current project in the connected repository. 
IfsuccessThen
     MyRepository.XFRACAS.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.XFRACASDiagnosticsEntryType.Information) 
    Try
        DimListOfXFRACASEntities()AsSynthesisAPI.NameIdPair = MyRepository.XFRACAS.GetAllXFRACASEntities()
        ForiAs Integer= 0ToListOfXFRACASEntities.GetUpperBound(0)
             MessageBox.Show(ListOfXFRACASEntities(i).Name)
        Next
    CatchexAsException
         'Write error message to diagnostics log 
         MyRepository.XFRACAS.WriteToDiagosticsLog(ex, SynthesisAPI.XFRACASDiagnosticsEntryType.Error, "Reading Entities")
    End Try
End If