<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head profile="http://internetalchemy.org/2003/02/profile"> <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" /> <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" /> <meta name="dc.title" content="Function: soap_box_xml_entity - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: soap_box_xml_entity - Virtuoso Functions Guide" /> <meta name="dc.creator" content="OpenLink Software Documentation Team ; " /> <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" /> <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" /> <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" /> <link rel="parent" href="functions.html" title="Chapter Contents" /> <link rel="prev" href="appendixa.html" title="Appendix" /> <link rel="next" href="functions.html#.html" title="" /> <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" /> <link rel="stylesheet" type="text/css" href="doc.css" /> <link rel="stylesheet" type="text/css" href="/doc/translation.css" /> <title>Function: soap_box_xml_entity - Virtuoso Functions Guide</title> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" /> <meta name="author" content="OpenLink Software Documentation Team ; " /> <meta name="copyright" content="OpenLink Software, 1999 - 2009" /> <meta name="keywords" content="" /> <meta name="GENERATOR" content="OpenLink XSLT Team" /> </head> <body> <div id="header"> <a name="fn_soap_box_xml_entity" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - soap_box_xml_entity</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_http_body_read.html" title="http_body_read">Prev</a> | <a class="link" href="fn_soap_dt_define.html" title="soap_dt_define">Next</a> </div> </div> <div id="currenttoc"> <form method="post" action="/doc/adv_search.vspx"> <div class="search">Keyword Search: <br /> <input type="text" name="q" /> <input type="submit" name="go" value="Go" /> </div> </form> <div> <a href="http://www.openlinksw.com/">www.openlinksw.com</a> </div> <div> <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a> </div> <br /> <div> <a href="index.html">Book Home</a> </div> <br /> <div> <a href="contents.html">Contents</a> </div> <div> <a href="preface.html">Preface</a> </div> <br /> <div> <a class="selected" href="functions.html">Virtuoso Functions Guide</a> </div> <br /> <div> <a href="functions.html#admin">Administration</a> </div> <div> <a href="functions.html#aggr">Aggregate Functions</a> </div> <div> <a href="functions.html#array">Array Manipulation</a> </div> <div> <a href="functions.html#bpel">BPEL APIs</a> </div> <div> <a href="functions.html#backup">Backup</a> </div> <div> <a href="functions.html#compression">Compression</a> </div> <div> <a href="functions.html#cursors">Cursor</a> </div> <div> <a href="functions.html#time">Date & Time Manipulation</a> </div> <div> <a href="functions.html#debug">Debug</a> </div> <div> <a href="functions.html#dict">Dictionary Manipulation</a> </div> <div> <a href="functions.html#encoding">Encoding & Decoding</a> </div> <div> <a href="functions.html#file">File Manipulation</a> </div> <div> <a href="functions.html#ft">Free Text</a> </div> <div> <a href="functions.html#hash">Hashing / Cryptographic</a> </div> <div> <a href="functions.html#ldap">LDAP</a> </div> <div> <a href="functions.html#localization">Locale</a> </div> <div> <a href="functions.html#mail">Mail</a> </div> <div> <a href="functions.html#misc">Miscellaneous</a> </div> <div> <a href="functions.html#number">Number</a> </div> <div> <a href="functions.html#phrz">Phrases</a> </div> <div> <a href="functions.html#rdf">RDF data</a> </div> <div> <a href="functions.html#rmt">Remote SQL Data Source</a> </div> <div> <a href="functions.html#repl">Replication</a> </div> <div> <a class="selected" href="functions.html#soap">SOAP</a> </div> <div class="selected"> <div> <a href="fn_http_body_read.html">http_body_read</a> </div> <div> <a href="fn_soap_box_structure.html">soap_box_structure</a> </div> <div> <a class="selected" href="fn_soap_box_xml_entity.html">soap_box_xml_entity</a> </div> <div> <a href="fn_soap_call.html">soap_call</a> </div> <div> <a href="fn_soap_client.html">soap_client</a> </div> <div> <a href="fn_soap_current_url.html">soap_current_url</a> </div> <div> <a href="fn_soap_dt_define.html">soap_dt_define</a> </div> <div> <a href="fn_soap_make_error.html">soap_make_error</a> </div> <div> <a href="fn_soap_print_box.html">soap_print_box</a> </div> <div> <a href="fn_soap_sdl.html">soap_sdl</a> </div> <div> <a href="fn_soap_server.html">soap_server</a> </div> <div> <a href="fn_soap_wsdl.html">soap_wsdl</a> </div> <div> <a href="fn_soap_wsdl_import.html">soap_wsdl_import</a> </div> <div> <a href="fn_wst_cli.html">wst_cli</a> </div> </div> <div> <a href="functions.html#sql">SQL</a> </div> <div> <a href="functions.html#string">String</a> </div> <div> <a href="functions.html#txn">Transaction</a> </div> <div> <a href="functions.html#type">Type Mapping</a> </div> <div> <a href="functions.html#uddi">UDDI</a> </div> <div> <a href="functions.html#udt">User Defined Types & The CLR</a> </div> <div> <a href="functions.html#vad">VAD</a> </div> <div> <a href="functions.html#jvmpl">Virtuoso Java PL API</a> </div> <div> <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a> </div> <div> <a href="functions.html#ws">Web & Internet</a> </div> <div> <a href="functions.html#xml">XML</a> </div> <div> <a href="functions.html#XPATH">XPATH & XQUERY</a> </div> <br /> <div> <a href="functionidx.html">Functions Index</a> </div> <br /> </div> <div id="text"> <h2>soap_box_xml_entity</h2> <div class="refpurpose">Converts an XML entity to an SQL value given the desired SQL type.</div> <div class="funcsynopsis"> <span class="funcdef">any <span class="function">soap_box_xml_entity</span> </span> (<span class="paramdef">in <span class="parameter">entity</span> any</span>, <span class="paramdef">in <span class="parameter">try_typed_as</span> any</span>, <span class="paramdefoptional">[in <span class="optional">soap_version</span> integer]</span>); </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p> 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. </p> </div> <div class="refsect1"> <div class="refsect1title">Parameters</div> <div class="refsect2"> <span class="refsect2title">entity – </span> The XML fragment as a vector (as returned from <span class="computeroutput">xml_tree()</span> or a subpart of it).</div> <div class="refsect2"> <span class="refsect2title">try_typed_as – </span> A sample value, whose type is taken as a desired type for conversion.</div> <div class="refsect2"> <span class="refsect2title">soap_version – </span> Optional (default 1). The soap version (1 for SOAP 1.0, 11 for SOAP 1.1).</div> </div> <div class="refsect1"> <div class="refsect1title">Return Types</div> <p>The return type of <span class="computeroutput">soap_box_xml_entity()</span> can vary according to the type of <span class="computeroutput">entity</span> parameter, described by <span class="computeroutput">try_typed_as</span> as follows:</p> <ul> <li>If entity is NULL, the return value will be NULL.</li> <li>If entity is not a vector() then its value will be cast to the try_typed_as type, if possible.</li> <li>If entity is 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 the entity argument.</li> </ul> </div> </div> <div id="footer"> <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div> <div id="validation"> <a href="http://validator.w3.org/check/referer"> <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /> </a> <a href="http://jigsaw.w3.org/css-validator/"> <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" /> </a> </div> </div> </body> </html>