Namespace: Consultingwerk.Util
Class 
XmlSerializationHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.XmlSerializationHelper

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
INTEGER CountOf (integer) Returns the number of entries of an array
RAW DecodeRaw (character) Returns the RAW value of a base64-encoded string
DeserializeArrayProperty (handle, Object, character, character) Assigns a primitive EXTENT property from the Item child elements of the property node
InsertItem (handle, longchar, logical) Adds an Item element to the property node
LOGICAL IsArrayType (character) Returns if the type is a primitive EXTENT type supported by SerializeArrayProperty and DeserializeArrayProperty
LOGICAL IsItemNode (handle) Returns if the node is an Item element
LOGICAL IsUnknownItem (handle) Returns if the Item element marks an unknown entry
INTEGER ReadItems (handle, character[], logical[]) Reads the values of the Item child elements as CHARACTER values
INTEGER ReadLongcharItems (handle, longchar[], logical[]) Reads the values of the Item child elements as LONGCHAR values
SerializeArrayProperty (handle, Object, character, character) Writes the entries of a primitive EXTENT property as Item child elements of the property node

Top Constructor Summary
Options Name Purpose
XmlSerializationHelper () Constructor for the XmlSerializationHelper class

Top Property Summary
Options Name Purpose
CHARACTER ItemElementName
CHARACTER UnknownAttributeName


Method Detail
Top

INTEGER CountOf (integer)
Purpose: Returns the number of entries of an array
Notes: The extent of an indeterminate array is unknown

Parameters:
piExtent INTEGER
The result of the EXTENT function
Returns INTEGER
The number of entries, 0 for an indeterminate array
Top

RAW DecodeRaw (character)
Purpose: Returns the RAW value of a base64-encoded string
Notes:

Parameters:
pcEncoded CHARACTER
The base64-encoded value
Returns RAW
The decoded RAW value
Top

DeserializeArrayProperty (handle, Object, character, character)
Purpose: Assigns a primitive EXTENT property from the Item child elements
of the property node
Notes: The property is left unchanged when the node contains no Item
elements

Parameters:
phPropertyNode HANDLE
The X-NODEREF of the property element
poInstance Progress.Lang.Object
The object instance that exposes the property
pcProperty CHARACTER
The name of the property
pcType CHARACTER
The type of the property, e.g. INTEGER EXTENT
Top

InsertItem (handle, longchar, logical)
Purpose: Adds an Item element to the property node
Notes:

Parameters:
phPropertyNode HANDLE
The X-NODEREF of the property element
plcValue LONGCHAR
The value of the entry
plUnknown LOGICAL
Logical value indicating if the entry is unknown
Top

LOGICAL IsArrayType (character)
Purpose: Returns if the type is a primitive EXTENT type supported by
SerializeArrayProperty and DeserializeArrayProperty
Notes:

Parameters:
pcType CHARACTER
The type of the property, e.g. INTEGER EXTENT
Returns LOGICAL
Logical value indicating if the type is a supported primitive EXTENT type
Top

LOGICAL IsItemNode (handle)
Purpose: Returns if the node is an Item element
Notes:

Parameters:
phNode HANDLE
The X-NODEREF to test
Returns LOGICAL
Logical value indicating if the node is an Item element
Top

LOGICAL IsUnknownItem (handle)
Purpose: Returns if the Item element marks an unknown entry
Notes:

Parameters:
phItemNode HANDLE
The X-NODEREF of the Item element
Returns LOGICAL
Logical value indicating if the entry is unknown
Top

INTEGER ReadItems (handle, character[], logical[])
Purpose: Reads the values of the Item child elements as CHARACTER values
Notes:

Parameters:
phPropertyNode HANDLE
The X-NODEREF of the property element
pcValues CHARACTER
OUTPUT The values of the Item elements
plUnknown LOGICAL
OUTPUT Logical values indicating if an entry is unknown
Returns INTEGER
The number of Item elements
Top

INTEGER ReadLongcharItems (handle, longchar[], logical[])
Purpose: Reads the values of the Item child elements as LONGCHAR values
Notes:

Parameters:
phPropertyNode HANDLE
The X-NODEREF of the property element
plcValues LONGCHAR
OUTPUT The values of the Item elements
plUnknown LOGICAL
OUTPUT Logical values indicating if an entry is unknown
Returns INTEGER
The number of Item elements
Top

SerializeArrayProperty (handle, Object, character, character)
Purpose: Writes the entries of a primitive EXTENT property as Item child
elements of the property node
Notes: An indeterminate array writes no Item elements

Parameters:
phPropertyNode HANDLE
The X-NODEREF of the property element
poInstance Progress.Lang.Object
The object instance that exposes the property
pcProperty CHARACTER
The name of the property
pcType CHARACTER
The type of the property, e.g. INTEGER EXTENT


Constructor Detail
Top

XmlSerializationHelper ()
Purpose: Constructor for the XmlSerializationHelper class
Notes: Disallow instance creation



Property Detail
Top

CHARACTER ItemElementName

Returns CHARACTER
Top

CHARACTER UnknownAttributeName

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:17:05