SaveXMLtoDim Method (LISTVIEW)


9.3A, PLBCMP GUI Only

 

The SaveXMLtoDim method stores the contents of a LISTVIEW object into a DIM variable. The method uses the following format:

 

 

[label]

{object}.SaveXMLtoDim

[GIVING {return}] USING [*Options=]{options}][:

 

 

 

[*TableName=]{tname}][:

 

 

 

[*RowName=]{rname}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is accessed.

return

Optional. A Character String Variable that receives the XML data from the LISTVIEW object.

options

Optional. A decimal number or Numeric Variable that specifies the load options.

tname

Optional. A Character String Variable or literal that specifies the table name.

rname

Optional. A Character String Variable or literal that specifies the row name.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The ZERO and OVER Condition Flags are always cleared.

  2. The EOS Condition Flag is set when the XML data is truncated and {return} is specified.

  3. The {options}, {tname}, and {rname} descriptions are the same as the SaveXmlFile method for the LISTVIEW object.

  4. The error values for the SaveXmlToDim method are the same as the SaveXmlFile method. When an error occurs for the SaveXmlToDim method, the error value is returned in the {return} variable as follows:

  5.  

    Error: {nnn}

     

    Where:

    {nnn}

    is the error value returned as a decimal number.

     

  6. When using LISTVIEW methods that use the Column names for XML output, the Column names must conform to XML Basic requirements. See the XML Basics description for more details. This is the basic description where LISTVIEW Columns are output as XML tag names:

  7.  

    " Tag names are case-sensitive and must start with letters, or an underscore. The rest of the tag name can contain letters, digits, hyphens, underscores, and periods."

     

    When the LISTVIEW Column names contain invalid characters for XML tag names, the $LV_XMLWR_OUTPUTASATTR option should be used where appropriate for the LISTVIEW methods being used.

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference SaveXMLFile Method (LISTVIEW) SetColResizeFlag (LISTVIEW)