GetXMLDataSize Method (LISTVIEW)
9.3A, PLBCMP GUI Only
The GetXMLDataSize method returns the size required for a Character String Variable to receive all of the LISTVIEW data stored in XML format. The method uses the following format:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A LISTVIEW object that is accessed.
return
Optional. A Numeric Variable that receives expected XML data size for the LISTVIEW object data.
options
Optional. A decimal number or Numeric Variable that specifies the store 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:
If the value returned is zero, the ZERO Condition Flag is set.
If {return} is too small to contain the numeric value, the OVER Condition Flag is set.
The EOS Condition Flag is always cleared.
The {options}, {tname}, and {rname} descriptions are the same as the SaveXmlFile method for the LISTVIEW object.
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:
" 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
|
|