|
|
| (4 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| {{Template:APIClass|Repository Class|Repository}}
| | #REDIRECT [[Repository.XFRACAS.WriteMessageToDiagnosticsLog]] |
| | |
| {{Template:Repository.WriteToDiagnosticsLog.Cmt}}
| |
| | |
| | |
| =First Available Method=
| |
| Writes a message to the diagnostics log
| |
| | |
| == Syntax ==
| |
| *WriteToDiagnosticsLog(message {{APIPrefix|As String}} , entrytype {{APIPrefix|As}} [[Repository.XFRACASDiagnosticEntryType|XFRACASDiagnosticEntryType]])
| |
| | |
| Parameters
| |
| :''message'': Message to write to the diagnostics log
| |
| :''entryType'': The type of diagnostics entry type, specified as [[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]]
| |
| | |
| =Second Available Method=
| |
| Writes exception information to the diagnostics log
| |
| | |
| == Syntax ==
| |
| *WriteToDiagnosticsLog(exObject {{APIPrefix|As}} System.Exception , entrytype {{APIPrefix|As}} [[Repository.XFRACASDiagnosticEntryType|XFRACASDiagnosticEntryType]], {{APIPrefix| Optional}} comment{{APIPrefix|As String}})
| |
| | |
| Parameters
| |
| :''exObject'': Represents an error that occurs during application execution
| |
| :''entryType'': The type of diagnostics entry type, specified as [[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]]
| |
| :''comment'': ''Optional'' comment to write to the diagnostics log
| |
| | |
| = Usage Example =
| |
| {{APIComment|Code Block}}
| |
| | |
|
| |
| '{{APIComment|Connect to the Synthesis repository.}}
| |
| {{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.}}
| |
| {{APIPrefix|If}} success {{APIPrefix|Then}}
| |
| {{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)
| |
| {{APIPrefix|Next}}
| |
| '{{APIComment|Write error message to diagnostics log}}
| |
| {{APIPrefix|Catch}} ex {{APIPrefix|As}} Exception
| |
| MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]](ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
| |
| {{APIPrefix|End Try}}
| |
| {{APIPrefix|Else}}
| |
| '{{APIComment|Write warning message to diagnostics log}}
| |
| MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]]("Unable to connect to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Warning)
| |
| {{APIPrefix|End If}}
| |