Repository.BlockSim.ImportBlockSimXMLFile: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIClass|Repository Class|Repository}}
Synthesis API allows the programmer to import XML files into a current project of BlockSim. The page contains the logic of that importation. All XML files must first be in XML format before they can be successfully imported. Below is a screenshot of an XML file that this page will show imported.
Synthesis API allows the programmer to import XML files into a current project of BlockSim. The page contains the logic of that importation. All XML files must first be in XML format before they can be successfully imported. This page will demonstrate the importation process.


== Method Syntax  ==
== Method Syntax  ==

Revision as of 23:11, 29 January 2014


Synthesis API allows the programmer to import XML files into a current project of BlockSim. The page contains the logic of that importation. All XML files must first be in XML format before they can be successfully imported. This page will demonstrate the importation process.

Method Syntax

Public Function ImportBlockSimXMLFile( ByVal XMLFile As String ) As Boolean


Parameters

XMLFile The path for the XML file to import.

Usage Example

Code Block

' Declare a new repository connection class. 
Private WithEvents MyRepository As New Repository
' Connect to the Synthesis repository. 
DimSuccessAs Boolean=False
 Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")
' Import the XML File to the Synthesis repository. 
DimSuccessImportXMLAs Boolean
 SuccessImportXML = MyRepository.ImportXFRACASXMLFile("XMLFilePath")

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.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")

Import the XML File to the Synthesis repository.

       Dim SuccessImportXML As Boolean
       SuccessImportXML = MyRepository.ImportXFRACASXMLFile("XMLFilePath")