# 22. Virtuoso Functions Guide - soap_box_structure

Chapter Contents | Prev | Next
Keyword Search:
www.openlinksw.com
docs.openlinksw.com
Book Home
Contents
Preface
Virtuoso Functions Guide
Administration
Aggregate Functions
Array Manipulation
BPEL APIs
Backup
Compression
Cursor
Date & Time Manipulation
Debug
Dictionary Manipulation
Encoding & Decoding
File Manipulation
Free Text
Hashing / Cryptographic
LDAP
Locale
Mail
Miscellaneous
Number
Remote SQL Data Source
Replication
SOAP
http_body_read
soap_box_structure
soap_box_xml_entity
soap_call
soap_client
soap_current_url
soap_dt_define
soap_make_error
soap_print_box
soap_sdl
soap_server
soap_wsdl
soap_wsdl_import
wst_cli
SQL
String
Transaction
Type Mapping
UDDI
User Defined Types & The CLR
Virtuoso Java PL API
Virtuoso Server Extension Interface (VSEI)
Web Server & Internet
XML
XPATH & XQUERY
Functions Index

## soap_box_structure

any soap_box_structure (in elem1 varchar, in value1 any, in ... , in elem1 varchar, in value1 any);
Description

This function provides a way to encapsulate a structure suitable for soap serialization. It accepts a name/value pairs which represents name and value of elements of a structure.

For example structure :

    	  {
    	    varString 'hello',
    	      varInt  1234
    	  }

will be represented as soap_box_structure ('varString', 'hello', 'varInt', 1234); futhermore value returned from soap_box_structure passed as an output parameter to the procedure (named structname) working as SOAP method will return :

    	      <structName>
    		  <varString>hello</varString>
    		  <varInt>1234</varInt>
    	  </structName>

Please note that this is a one of posibilities to express structures for SOAP request/response in Virtuoso/PL. The other way to express structure is to use User Defined Types (see SOAP & WSDL section of the documentation).

Parameters
elem – name which represents name of the member of a structure
value – value which represents value of the member of a structure
Return Types

The return type of soap_box_structure() is an array representing a structure.