<!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: xmlStorageSystem.getServerCapabilities - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: xmlStorageSystem.getServerCapabilities - 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: xmlStorageSystem.getServerCapabilities - 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_xmlStorageSystem.getServerCapabilities" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - xmlStorageSystem.getServerCapabilities</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_xmlStorageSystem.mailPasswordToUser.html" title="xmlStorageSystem.mailPasswordToUser">Prev</a> | <a class="link" href="fn_xmlStorageSystem.deleteMultipleFiles.html" title="xmlStorageSystem.deleteMultipleFiles">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 href="functions.html#soap">SOAP</a>
</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>xmlStorageSystem.getServerCapabilities</h2>
<div class="refpurpose">Retrieve server specific information.</div>
<div class="funcsynopsis">
<span class="funcdef">structure <span class="function">xmlStorageSystem.getServerCapabilities</span>
</span>
(<span class="paramdef">in <span class="parameter">email</span> string</span>,
<span class="paramdef">in <span class="parameter">password</span> string</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>This method is used to obtain information about the capabilities of the server, such as
files size limitations, supported types, etc...</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">email – </span>
For user identification, this should be a valid email account.</div>
<div class="refsect2">
<span class="refsect2title">password – </span>
The MD5 hash of the password.</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>This method returns a structure as follows:</p>
<div>
<pre class="programlisting">
'flError' boolean 0 success, 1 fault
'message' string fault message (can be used to handle error cases)
ctBytesInUse integer how many bytes are used on repository
legalFileExtensions string array which extensions are recognized
maxBytesPerUser integer total bytes available for this user
maxFileSize integer largest file size for upload (bytes)
yourUpstreamFolderUrl string base URL for user's blog on repository
</pre>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_XMLStorageSystem.getServerCapabilities" />
<div class="example">
<div class="exampletitle">Retrieving the XML Storage System Capabilities</div>
<p>Simple example of fetching the server capabilities.</p>
<div>
<pre class="screen">
SQL> SOAP_CLIENT (url=>'http://localhost:6666/xmlStorageSystem',
operation=>'getServerCapabilities', parameters=>vector
('email','user@example.domain', 'password', md5('xxx'));
SOAP response:
<getServerCapabilitiesResponse>
<Result>
<ctBytesInUse>14</ctBytesInUse>
<flError>0</flError>
<legalFileExtensions>
<item>ai</item>
<item>aif</item>
<item>aifc</item>
</legalFileExtensions>
<maxBytesPerUser>41943040</maxBytesPerUser>
<maxFileSize>1048576</maxFileSize>
<message />
<yourUpstreamFolderUrl>http://localhost:6666/DAV/user@example.domain/blog/</yourUpstreamFolderUrl>
</Result>
</getServerCapabilitiesResponse>
</pre>
</div>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_xmlStorageSystem.registerUser.html">xmlStorageSystem.registerUser()</a>
</p>
<p>
<a href="fn_xmlStorageSystem.mailPasswordToUser.html">xmlStorageSystem.mailPasswordToUser()</a>
</p>
<p>
<a href="fn_xmlStorageSystem.deleteMultipleFiles.html">xmlStorageSystem.deleteMultipleFiles()</a>
</p>
<p>
<a href="fn_xmlStorageSystem.saveMultipleFiles.html">xmlStorageSystem.saveMultipleFiles()</a>
</p>
</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
717
