Repository.XFRACAS.ProcessXfracasImports: Difference between revisions
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
== Usage Example == | == Usage Example == | ||
{{APIComment|Declare a new repository connection class.}} | {{APIComment|Declare a new repository connection class.}}<br> | ||
{{APIPrefix|Private WithEvents MyRepository As [[New Repository]] | {{APIPrefix|Private WithEvents MyRepository As [[New Repository]]<br> | ||
{{APIComment|Connect to the Synthesis repository.}} | {{APIComment|Connect to the Synthesis repository.}}<br> | ||
{{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}} | {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}<br> | ||
Success = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath") | Success = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")<br> | ||
{{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.}}<br> | ||
{{APIPrefix|Dim ListOfXFRACASEntities() {{APIPrefix|As [[NameIdPair Class|NameIdPair]]}} | {{APIPrefix|Dim ListOfXFRACASEntities() {{APIPrefix|As [[NameIdPair Class|NameIdPair]]}}<br> | ||
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities() | ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()<br> | ||
{{APIComment|Import the XML file into the entity desired. In this example, the first entity is used.}} | {{APIComment|Import the XML file into the entity desired. In this example, the first entity is used.}}<br> | ||
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}} | {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}<br> | ||
ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription") | ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")<br> | ||
{{APIComment|Process the imported file.}} | {{APIComment|Process the imported file.}}<br> | ||
MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]() | MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]()<br> | ||
Revision as of 22:26, 18 October 2013
Immediately processes imported files.
Method Syntax
ProcessXfracasImports()
Immediately processes imported files.
Usage Example
Declare a new repository connection class.
{{APIPrefix|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.
{{APIPrefix|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()
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()