Repository.BlockSim.ExportBlockSimXMLFile: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|Repository Class|Repository}} Synthesis API allows the programmer to export XML files out of a current project of BlockSim. The page contains the logic of tha…')
 
No edit summary
Line 2: Line 2:
Synthesis API allows the programmer to export XML files out of a current project of BlockSim. The page contains the logic of that importation. This page will demonstrate the exportation process.
Synthesis API allows the programmer to export XML files out of a current project of BlockSim. The page contains the logic of that importation. This page will demonstrate the exportation process.


== Method Syntax  ==
== Syntax  ==
{{APIName|Public Function '''ExportBlockSimXMLFile'''(}}
*ExportBlockSimXMLFile( FileName {{APIPrefix|As String}} ) {{APIPrefix|As Boolean}}
{{APIPrefix|ByVal}}
{{APIName|FileName}}
{{APIPrefix|As String}}
{{APIName|)}}
{{APIPrefix|As Boolean}}<br>


 
Parameters
== Parameters ==
:''FileName'': XML file name.
'''FileName'''
{{APIComment|XML file name}}


== Usage Example ==
== Usage Example ==

Revision as of 20:25, 27 February 2014


Synthesis API allows the programmer to export XML files out of a current project of BlockSim. The page contains the logic of that importation. This page will demonstrate the exportation process.

Syntax

  • ExportBlockSimXMLFile( FileName As String ) As Boolean

Parameters

FileName: XML file name.

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")
' Export the XML File out of the Synthesis repository. 
DimSuccessExportXMLAs Boolean
 SuccessExportXML = MyRepository.ExportBlockSimXMLFile("XML_File_Name")

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")

Export the XML File out of the Synthesis repository.

       Dim SuccessExportXML As Boolean
       SuccessImportXML = MyRepository.ExportBlockSimXMLFile("XML_File_Name")