Repository.XFRACAS.SerializeXMLObjectToByteArray - Revision history

Kate Racaza at 16:44, 10 March 2016

2016-03-10T16:44:44Z

← Older revision		Revision as of 16:44, 10 March 2016
Line 22:		Line 22:
	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'~~Add code~~ to ~~connect to the~~ Synthesis enterprise repository.}}		{{APIComment\|'Connect to a Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|~~...~~}}		MyRepository.ConnectToSQLRepository({{APIString\|"MyServer"}}, {{APIString\|"MyDatabase"}})

	{{APIComment\|'Define a serializable XML object and populate with values to import.}}		{{APIComment\|'Define a serializable XML object and populate with values to import.}}

Kate Racaza at 22:32, 13 November 2015

2015-11-13T22:32:30Z

← Older revision		Revision as of 22:32, 13 November 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:Repository.XFRACAS.SerializeXMLObjectToByteArray Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.SerializeXMLObjectToByteArray Method}}{{Template:API}}{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

Kate Racaza at 18:45, 9 November 2015

2015-11-09T18:45:14Z

← Older revision		Revision as of 18:45, 9 November 2015
Line 2:		Line 2:


	<onlyinclude>Serializes an XML file for import into XFRACAS. Returns a '''Boolean''' value; when true, indicates a successful serialization.</onlyinclude>		<onlyinclude>Serializes the XML file for import into XFRACAS. Returns a '''Boolean''' value; when true, indicates a successful serialization.</onlyinclude>

	== Syntax ==		== Syntax ==

Kate Racaza at 15:15, 5 November 2015

2015-11-05T15:15:27Z

← Older revision		Revision as of 15:15, 5 November 2015
Line 22:		Line 22:
	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Add code to connect to the Synthesis repository.}}		{{APIComment\|'Add code to connect to the Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|...}}		{{APIComment\|...}}

Kate Racaza at 19:58, 28 October 2015

2015-10-28T19:58:37Z

← Older revision		Revision as of 19:58, 28 October 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:Repository.XFRACAS.SerializeXMLObjectToByteArray Method}}{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.SerializeXMLObjectToByteArray Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}

Kate Racaza at 18:36, 27 October 2015

2015-10-27T18:36:24Z

← Older revision		Revision as of 18:36, 27 October 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.SerializeXMLObjectToByteArray Method}}{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}


Line 37:		Line 37:
	{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}		{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
	{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	ImportXMLSystemID = MyRepository.XFRACAS.~~ImportXFRACASXML~~(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})		ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

	{{APIComment\|'Process the imported file.}}		{{APIComment\|'Process the imported file.}}
	MyRepository.XFRACAS.ProcessXfracasImports()		MyRepository.XFRACAS.ProcessXfracasImports()

Kate Racaza at 18:20, 27 October 2015

2015-10-27T18:20:04Z

← Older revision		Revision as of 18:20, 27 October 2015
Line 2:		Line 2:


	<onlyinclude>Serializes an XML file for import into XFRACAS. Returns a '''Boolean''' value; when true, indicates a successful ~~import~~.</onlyinclude>		<onlyinclude>Serializes an XML file for import into XFRACAS. Returns a '''Boolean''' value; when true, indicates a successful serialization.</onlyinclude>

	== Syntax ==		== Syntax ==
	'''XFRACAS.SerializeXMLObjectToByteArray( pData() ~~{{APIPrefix\|As Byte}}~~, pObject ~~{{APIPrefix\|As Object}}) {{APIPrefix\|As Integer}}'~~''		'''.XFRACAS.SerializeXMLObjectToByteArray'''(''pData()'', ''pObject'')

	===Parameters===		===Parameters===
Line 11:		Line 11:
	''pData''		''pData''

	:Required. Byte.		:Required. Byte. A defined byte array.

	''pObject''		''pObject''

Kate Racaza at 17:57, 27 October 2015

2015-10-27T17:57:12Z

← Older revision		Revision as of 17:57, 27 October 2015
Line 9:		Line 9:
	===Parameters===		===Parameters===

	''pData'		''pData''

	:Required. Byte.		:Required. Byte.

Kate Racaza at 17:56, 27 October 2015

2015-10-27T17:56:01Z

← Older revision		Revision as of 17:56, 27 October 2015
Line 1:		Line 1:
	{{Template:~~APIClass~~\|Repository Class\|Repository}}		{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}
	~~A helper function to serialize XMLs~~ for import into XFRACAS ~~through~~ a ~~byte array~~.

			<onlyinclude>Serializes an XML file for import into XFRACAS. Returns a '''Boolean''' value; when true, indicates a successful import.</onlyinclude>

	== Syntax ==		== Syntax ==
	*SerializeXMLObjectToByteArray( pData() {{APIPrefix\|As Byte}}, pObject {{APIPrefix\|As Object}}) {{APIPrefix\|As Integer}}		'''XFRACAS.SerializeXMLObjectToByteArray( pData() {{APIPrefix\|As Byte}}, pObject {{APIPrefix\|As Object}}) {{APIPrefix\|As Integer}}'''

			===Parameters===

			''pData'

			:Required. Byte.

			''pObject''

			:Required. A serializable XML object.

	~~Parameters~~		== Example ==
	~~:''pData'': A defined byte array to return the~~

	~~:''pObject'': A serializable XML object.~~

	~~== Usage Example ==~~		'''VB.NET'''
	'~~{{APIComment\|Declare a new repository connection class~~.}}
	~~{{APIPrefix\|Private WithEvents MyRepository As New [[Repository Class\|Repository]]}}~~		{{APIComment\|'Add code to connect to the Synthesis repository.}}
	'{{APIComment\|~~Connect~~ to the ~~desired~~ Synthesis repository.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIPrefix\|Dim}} ~~Success~~ {{APIPrefix\|As ~~Boolean~~}} = {{~~APIPrefix~~\|~~False~~}}		{{APIComment\|...}}
	~~Success = MyRepository.[[Repository.ConnectToRepository\|ConnectToRepository]]("RepositoryFileNamePath")~~
	'{{APIComment\|Define an serializable XML ~~Object~~.}}		{{APIComment\|'Define a serializable XML object and populate with values to import.}}
	{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}}={{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}} = {{APIPrefix\|Nothing}}
	{{APIComment\|~~'populate the xmlObject with values to import~~}}		{{APIComment\|...}}
	'{{APIComment\|Define the byte array.}}
	{{APIPrefix\|Dim}} byteArray {{APIPrefix\|As Byte()}}={{APIPrefix\|Nothing}}		{{APIComment\|'Define the byte array and then serialize the object to the byte array.}}
	'{{APIComment\|~~Serialize~~ the ~~xmlObject~~ into ~~the byteArray~~.}}		{{APIPrefix\|Dim}} byteArray {{APIPrefix\|As Byte()}} = {{APIPrefix\|Nothing}}
	{{APIPrefix\|Dim}} ~~SerializeSuccess~~ {{APIPrefix\|As ~~Boolean~~}}		{{APIPrefix\|Dim}} SerializeSuccess {{APIPrefix\|As Boolean}}
	~~SerializeSuccess~~ = MyRepository.XFRACAS.~~[[Repository~~.~~SerializeXMLObjectToByteArray~~\|~~SerializeXMLObjectToByteArray]]~~(~~byteArray, xmlObject~~)		SerializeSuccess = MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)

			{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
			{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
			ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXML(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

			{{APIComment\|'Process the imported file.}}
			MyRepository.XFRACAS.ProcessXfracasImports()

Alex Ulanov at 15:56, 27 May 2015

2015-05-27T15:56:40Z

@@ Line 23: / Line 23: @@
   '{{APIComment|Serialize the xmlObject into the byteArray.}}
   {{APIPrefix|Dim}} SerializeSuccess {{APIPrefix|As Boolean}}
-  SerializeSuccess = MyRepository.[[Repository.SerializeXMLObjectToByteArray|SerializeXMLObjectToByteArray]](byteArray, xmlObject)
+  SerializeSuccess = MyRepository.XFRACAS.[[Repository.SerializeXMLObjectToByteArray|SerializeXMLObjectToByteArray]](byteArray, xmlObject)

← Older revision		Revision as of 16:44, 10 March 2016
Line 22:		Line 22:
	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'~~Add code~~ to ~~connect to the~~ Synthesis enterprise repository.}}		{{APIComment\|'Connect to a Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|~~...~~}}		MyRepository.ConnectToSQLRepository({{APIString\|"MyServer"}}, {{APIString\|"MyDatabase"}})

	{{APIComment\|'Define a serializable XML object and populate with values to import.}}		{{APIComment\|'Define a serializable XML object and populate with values to import.}}

← Older revision		Revision as of 18:36, 27 October 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.SerializeXMLObjectToByteArray Method}}{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}


Line 37:		Line 37:
	{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}		{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
	{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	ImportXMLSystemID = MyRepository.XFRACAS.~~ImportXFRACASXML~~(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})		ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

	{{APIComment\|'Process the imported file.}}		{{APIComment\|'Process the imported file.}}
	MyRepository.XFRACAS.ProcessXfracasImports()		MyRepository.XFRACAS.ProcessXfracasImports()

← Older revision		Revision as of 17:56, 27 October 2015
Line 1:		Line 1:
	{{Template:~~APIClass~~\|Repository Class\|Repository}}		{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}
	~~A helper function to serialize XMLs~~ for import into XFRACAS ~~through~~ a ~~byte array~~.

			<onlyinclude>Serializes an XML file for import into XFRACAS. Returns a '''Boolean''' value; when true, indicates a successful import.</onlyinclude>

	== Syntax ==		== Syntax ==
	*SerializeXMLObjectToByteArray( pData() {{APIPrefix\|As Byte}}, pObject {{APIPrefix\|As Object}}) {{APIPrefix\|As Integer}}		'''XFRACAS.SerializeXMLObjectToByteArray( pData() {{APIPrefix\|As Byte}}, pObject {{APIPrefix\|As Object}}) {{APIPrefix\|As Integer}}'''

			===Parameters===

			''pData'

			:Required. Byte.

			''pObject''

			:Required. A serializable XML object.

	~~Parameters~~		== Example ==
	~~:''pData'': A defined byte array to return the~~

	~~:''pObject'': A serializable XML object.~~

	~~== Usage Example ==~~		'''VB.NET'''
	'~~{{APIComment\|Declare a new repository connection class~~.}}
	~~{{APIPrefix\|Private WithEvents MyRepository As New [[Repository Class\|Repository]]}}~~		{{APIComment\|'Add code to connect to the Synthesis repository.}}
	'{{APIComment\|~~Connect~~ to the ~~desired~~ Synthesis repository.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIPrefix\|Dim}} ~~Success~~ {{APIPrefix\|As ~~Boolean~~}} = {{~~APIPrefix~~\|~~False~~}}		{{APIComment\|...}}
	~~Success = MyRepository.[[Repository.ConnectToRepository\|ConnectToRepository]]("RepositoryFileNamePath")~~
	'{{APIComment\|Define an serializable XML ~~Object~~.}}		{{APIComment\|'Define a serializable XML object and populate with values to import.}}
	{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}}={{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}} = {{APIPrefix\|Nothing}}
	{{APIComment\|~~'populate the xmlObject with values to import~~}}		{{APIComment\|...}}
	'{{APIComment\|Define the byte array.}}
	{{APIPrefix\|Dim}} byteArray {{APIPrefix\|As Byte()}}={{APIPrefix\|Nothing}}		{{APIComment\|'Define the byte array and then serialize the object to the byte array.}}
	'{{APIComment\|~~Serialize~~ the ~~xmlObject~~ into ~~the byteArray~~.}}		{{APIPrefix\|Dim}} byteArray {{APIPrefix\|As Byte()}} = {{APIPrefix\|Nothing}}
	{{APIPrefix\|Dim}} ~~SerializeSuccess~~ {{APIPrefix\|As ~~Boolean~~}}		{{APIPrefix\|Dim}} SerializeSuccess {{APIPrefix\|As Boolean}}
	~~SerializeSuccess~~ = MyRepository.XFRACAS.~~[[Repository~~.~~SerializeXMLObjectToByteArray~~\|~~SerializeXMLObjectToByteArray]]~~(~~byteArray, xmlObject~~)		SerializeSuccess = MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)

			{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
			{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
			ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXML(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

			{{APIComment\|'Process the imported file.}}
			MyRepository.XFRACAS.ProcessXfracasImports()