Repository.WriteToDiagnosticsLog: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
 
(14 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}}
 
This method is an overloaded method which means the same signature will accept different sets of arguments. Both available methods are shown separately.
 
=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 [[Repository.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 [[Repository.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.[[Repository.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.[[Repository.XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Warning)
  {{APIPrefix|End If}}
 
 
 
 
== Reformatted Usage Example ==
 
{{APIComment|Connect to the Synthesis repository.}}
        {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")
 
{{APIComment|Start "If" Statement}}
{{APIPrefix|If}} success {{APIPrefix|Then}}
           
{{APIComment|Start "try" Statement}}
{{APIPrefix|Try}}
 
{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
        {{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)
 
{{APIComment|Start diagnostics messages}}
        {{APIPrefix|Next}}
 
 
{{APIComment|Write error message to diagnostics log}}
{{APIPrefix|Catch}} ex {{APIPrefix|As}} Exception
                MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]](ex, SynthesisAPI.[[Repository.XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
 
{{APIComment|End "try" Statement}}
  {{APIPrefix|End Try}}
{{APIPrefix|Else}}
 
{{APIComment|Write warning message to diagnostics log}}
 
MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]]("Unable to connect to repository", SynthesisAPI.[[Repository.XFRACASDiagnosticsEntryType  Enumeration|XFRACASDiagnosticsEntryType]].Warning)
  {{APIPrefix|End If}}

Latest revision as of 19:05, 5 May 2016

Redirect to:

Retrieved from "https://www.reliawiki.com/index.php?title=Repository.WriteToDiagnosticsLog&oldid=63952"