Repository.XFRACAS.WriteExceptionToDiagnosticsLog: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) |
John Leavitt (talk | contribs) |
||
| Line 17: | Line 17: | ||
{{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}} | |||
MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Information) | |||
{{APIPrefix|Try}} | |||
{{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) | |||
MessageBox.Show(ListOfXFRACASEntities(i).Name) | MessageBox.Show(ListOfXFRACASEntities(i).Name) | ||
{{APIPrefix|Next}} | |||
'{{APIComment|Write error message to diagnostics log}} | |||
{{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 If}} | |||
Revision as of 21:21, 28 April 2014
Writes exception information to the diagnostics log
Syntax
- WriteToDiagnosticsLog(exObject As System.Exception , entrytype As XFRACASDiagnosticEntryType, Optional commentAs String)
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