Repository.WriteToDiagnosticsLog: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) (Created page with '{{Template:APIClass|Repository Class|Repository}} {{Template:Repository.WriteToDiagnosticsLog.Cmt}} == Syntax == *WriteToDiagnosticsLog({{APIPrefix|Optional ByVal}} message {{A…') |
John Leavitt (talk | contribs) No edit summary |
||
| Line 5: | Line 5: | ||
== Syntax == | == Syntax == | ||
*WriteToDiagnosticsLog({{APIPrefix|Optional ByVal}} message {{APIPrefix|As String}} , {{APIPrefix|Optional ByVal}} entrytype {{APIPrefix|As}} [[Repository.XFRACASDiagnosticEntryType|XFRACASDiagnosticEntryType]]) | *WriteToDiagnosticsLog({{APIPrefix|Optional ByVal}} message {{APIPrefix|As String}} , {{APIPrefix|Optional ByVal}} entrytype {{APIPrefix|As}} [[Repository.XFRACASDiagnosticEntryType|XFRACASDiagnosticEntryType]]) | ||
*WriteToDiagnosticsLog({{APIPrefix|ByVal}} exObject {{APIPrefix|As}} System.Exception, {{APIPrefix|ByVal}} entryType {{APIPrefix|As}} [[Repository.XFRACASDiagnosticsEntryType|XFRACASDiagnosticsEntryType]]{{APIPrefix|Optional ByVal}} comment {{APIPrefix|As String}} = "") | *WriteToDiagnosticsLog({{APIPrefix|ByVal}} exObject {{APIPrefix|As}} System.Exception, {{APIPrefix|ByVal}} entryType {{APIPrefix|As}} [[Repository.XFRACASDiagnosticsEntryType|XFRACASDiagnosticsEntryType]]{{APIPrefix|Optional ByVal}} comment {{APIPrefix|As String}} = "") | ||
| Line 25: | Line 26: | ||
MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]() | MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]() | ||
'{{APIComment|Create place to see where code is breaking instead of writing to your own logfile}} | '{{APIComment|Create place to see where code is breaking instead of writing to your own logfile}} | ||
MyRepository.[[Repository. | MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]](ByVal message As String, ByVal entryType As [[Repository.XFRACASDiagnosticsEntryType|XFRACASDiagnosticsEntryType]]) | ||
=== Reformatted Usage Example === | === Reformatted Usage Example === | ||
| Line 47: | Line 48: | ||
{{APIComment|Create place to see where code is breaking instead of writing to your own logfile}} | {{APIComment|Create place to see where code is breaking instead of writing to your own logfile}} | ||
MyRepository.[[Repository. | MyRepository.[[Repository.WriteToDiagnosticsLog|WriteToDiagosticsLog]](ByVal message As String, ByVal entryType As [[Repository.XFRACASDiagnosticsEntryType|XFRACASDiagnosticsEntryType]]) | ||
Revision as of 22:28, 25 April 2014
This subroutine adds diagnostic information into the diagnostics log. There are two methods that can be used. Both are shown.
Syntax
- WriteToDiagnosticsLog(Optional ByVal message As String , Optional ByVal entrytype As XFRACASDiagnosticEntryType)
- WriteToDiagnosticsLog(ByVal exObject As System.Exception, ByVal entryType As XFRACASDiagnosticsEntryTypeOptional ByVal comment As String = "")
Usage Example
Code Block
' Declare a new repository connection class. Private WithEvents MyRepository As New Repository ' Connect to the Synthesis repository. Dim Success As Boolean = False Success = MyRepository.ConnectToRepository("RepositoryFileNamePath") ' Get the list of XFRACAS Entities in the current project in the connected repository. Dim ListOfXFRACASEntities() As NameIdPair ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities() ' Import the XML file into the entity desired. In this example, the first entity is used. Dim ImportXMLSystemID As Integer ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription") ' Process the imported file. MyRepository.ProcessXfracasImports() ' Create place to see where code is breaking instead of writing to your own logfile MyRepository.WriteToDiagosticsLog(ByVal message As String, ByVal entryType As XFRACASDiagnosticsEntryType)
Reformatted Usage Example
Declare a new repository connection class.
Private WithEvents MyRepository As New Repository
Connect to the Synthesis repository.
Dim Success As Boolean = False
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
Get the list of XFRACAS Entities in the current project in the connected repository.
Dim ListOfXFRACASEntities() As NameIdPair ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()
Import the XML file into the entity desired. In this example, the first entity is used.
Dim ImportXMLSystemID As Integer
ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")
Process the imported file.
MyRepository.ProcessXfracasImports()
Create place to see where code is breaking instead of writing to your own logfile
MyRepository.WriteToDiagosticsLog(ByVal message As String, ByVal entryType As XFRACASDiagnosticsEntryType)