Repository.XFRACAS.SerializeXMLObjectToByteArray: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 12: Line 12:
== Usage Example ==
== Usage Example ==
  '{{APIComment|Declare a new repository connection class.}}
  '{{APIComment|Declare a new repository connection class.}}
  {{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}
  {{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}
  '{{APIComment|Connect to the desired Synthesis repository.}}
  '{{APIComment|Connect to the desired Synthesis repository.}}
  {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}
  {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}

Revision as of 17:15, 15 May 2014


A helper function to serialize XMLs for import into XFRACAS through a byte array.

Syntax

  • SerializeXMLObjectToByteArray( pData() As Byte, pObject As Object) As Integer

Parameters

pData: A defined byte array to return the
pObject: A serializable XML object.

Usage Example

' Declare a new repository connection class. 
Private WithEvents MyRepository As New Repository
' Connect to the desired Synthesis repository. 
Dim Success As Boolean = False
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
' Define an serializable XML Object. 
Dim xmlObject As Object=Nothing
 'populate the xmlObject with values to import 
' Define the byte array. 
Dim byteArray As Byte()=Nothing
' Serialize the xmlObject into the byteArray. 
Dim SerializeSuccess As Boolean
SerializeSuccess = MyRepository.SerializeXMLObjectToByteArray(byteArray, xmlObject)

Reformatted Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the desired Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Define an serializable XML Object.

       Dim xmlObject As Object = Nothing
       'populate the xmlObject with values to import

Define the byte array.

       Dim byteArray As Byte() = Nothing

Serialize the xmlObject into the byteArray.

       Dim SerializeSuccess As Boolean
       SerializeSuccess = MyRepository.SerializeXMLObjectToByteArray(byteArray, xmlObject)