Name
soap_box_xml_entity — Converts an XML entity to an SQL value given the desired SQL type.
Synopsis
any
soap_box_xml_entity
(
|
in entity any , |
| in try_typed_as any , | |
in
soap_version
integer
); |
Description
Converts an XML entity to an SQL value based on the type of the entity and the desired SQL type. This function is called internally to convert a SOAP request parameter to a PL procedure parameter when a SOAP request is being processed by the SOAP server.
Parameters
entity
The XML fragment as a vector (as returned from
xml_tree() or a subpart of it).
try_typed_as
A sample value, whose type is taken as a desired type for conversion.
soap_version
Optional (default 1). The soap version (1 for SOAP 1.0, 11 for SOAP 1.1).
Return Types
The return type of soap_box_xml_entity() can vary
according to the type of entity parameter,
described by try_typed_as as follows:
-
If
entityis NULL, the return value will be NULL. -
If
entityis not a vector() then its value will be cast to thetry_typed_astype, if possible. -
If
entityis a vector() containing XML tree then it will be converted to an appropriate SQL type (vector(), varchar, integer etc.) depending on the SOAP RPC encoding rules (XMLSchema-datatypes and SOAP-RPC encoding schema) for in/out SOAP messages. i.e. it depends on the structure/content of the XML tree passed as theentityargument.