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)  
        {{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.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
      MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
        {{APIPrefix|End Try}}
    {{APIPrefix|End Try}}
    {{APIPrefix|End If}}
  {{APIPrefix|End If}}

Revision as of 21:38, 28 April 2014
SynAPI.png
Main Page
Repository

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. 
DimSuccessAs Boolean=MyRepository.ConnectToRepository("RepositoryFileNamePath")
' Get the list of XFRACAS Entities in the current project in the connected repository. 
IfsuccessThen
        MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.XFRACASDiagnosticsEntryType.Information) 
    Try
        DimListOfXFRACASEntities()AsSynthesisAPI.NameIdPair=MyRepository.GetAllXFRACASEntities()
        ForiAs Integer=0ToListOfXFRACASEntities.GetUpperBound(0)
               MessageBox.Show(ListOfXFRACASEntities(i).Name)
        Next
        ' Write error message to diagnostics log 
    CatchexAsException
     MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.XFRACASDiagnosticsEntryType.Error, "Reading Entities")
   End Try
 End If
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.XFRACAS.WriteExceptionToDiagnosticsLog&oldid=53046"