Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions
Jump to navigation
Jump to search
Albert Szeto (talk | contribs) No edit summary |
Albert Szeto (talk | contribs) No edit summary |
||
| Line 15: | Line 15: | ||
{{APIPrefix|As String}} | {{APIPrefix|As String}} | ||
{{APIName|,}} | {{APIName|,}} | ||
{{APIPrefix|ByVal } | {{APIPrefix|ByVal }} | ||
{{APIName|fileDescription }} | {{APIName|fileDescription }} | ||
{{APIPrefix|As String}} | {{APIPrefix|As String}} | ||
| Line 22: | Line 22: | ||
{{APIComment|Uploads an import file for processing and returns the system ID of the uploaded}} | {{APIComment|Uploads an import file for processing and returns the system ID of the uploaded}} | ||
== Parameters == | |||
'''entityID''' | |||
{{APIComment|The ID of the entity to import into.}} | |||
'''ImportType''' | |||
{{APIComment|The type of XFRACAS Import to utilize.}} | |||
'''fileName''' | |||
{{APIComment|The file path of the XML file to import.}} | |||
'''fileDescription''' | |||
{{APIComment|A description of the XML to import.}} | |||
== Usage Example == | |||
{{APIComment|Declare a new repository connection class.}} | |||
Private WithEvents MyRepository As New Repository | |||
{{APIComment|Connect to the Synthesis repository.}} | |||
Dim Success As Boolean = False | |||
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath") | |||
{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}} | |||
Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]] | |||
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities() | |||
{{APIComment|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") | |||
Revision as of 23:03, 19 September 2013
Method Syntax
ImportXFRACASXMLFile( ByVal entityID As Integer , ByVal ImportType As XFRACASImportType, ByVal fileName As String , ByVal fileDescription As String ) As Integer
Uploads an import file for processing and returns the system ID of the uploaded
Parameters
entityID The ID of the entity to import into.
ImportType The type of XFRACAS Import to utilize.
fileName The file path of the XML file to import.
fileDescription A description of the XML to import.
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")