xml.Serializer.OptimizedStaxToVariable

Syntax

xml.Serializer.OptimizedStaxToVariable(
   stax xml.StaxReader,
   var fgl-type,
   xopTable RECORD )

1. stax is a StaxReader object where the cursor points to an XML Element node.
2. var is any Genero BDL data type. Or it can be a structured type, like a RECORD or ARRAY, including elements with these data types. Optional XML mapping attributes can be added to the definition of variables for XML serialization.
3. xopTable is a dynamic array, defined as follows:

   DEFINE XOPTable DYNAMIC ARRAY OF RECORD
     cid STRING, # Content-ID to identify the part in a XML Optimized document
     data BYTE,  # Blob handled as part in a XML Optimized document
     file STRING # Name of the file handled as part in an XML Optimized document
   END RECORD

   The XOPtable dynamic array is necessary to keep the relation between the data to be handled as separate part in an XML Optimized document via an href attribute containing the Content-ID value. This parameter can be NULL.

Usage

In case of error, the method throws an exception and sets the status variable. Depending on the error, a human-readable description of the problem is available in the sqlca.sqlerrm register. See Error handling in GWS calls (status).

Optimized APIs

Optimized APIs work in the same method as the non-Optimized APIs, with the addition that the optimized API supports XML-binary Optimized format, and return in the XOPTable (if not NULL) the BYTE or the file on disk to handle as a separate part based on the Content-ID.

For instance, if a BYTE has to be sent as an attachment via MTOM, the API will create an XML Optimized node with an href containing the Content-ID returned in the XOP table. This node will include a reference to that BYTE.

<m:data xmlns:m='http://example.org/stuff'>
  <m:photo>
  <xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include' 
  href='cid:myref@tempuri.org'/>
  </m:photo>
</m:data>