Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 5259

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XStruct</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XStruct-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdbc</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XStruct</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is used for the standard mapping for a SQL structured type.
 
 
 </dd>
<dd><p>
 A 
 <code>Struct</code>
 object contains a value for each attribute
 of the SQL structured type that it represents.
 By default, an instance of 
 <code>Struct</code>
 is valid as long as the
 application has a reference to it.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSQLTypeName">getSQLTypeName</a></td>
<td class="imsum_right">retrieves the SQL type name of the SQL structured type
 that this 
 <code>Struct</code>
 object represents.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAttributes">getAttributes</a></td>
<td class="imsum_right">produces the ordered values of the attributes of the SQL 
 structured type that this 
 <code>Struct</code>
 object represents. 
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getSQLTypeName" class="membertitle">getSQLTypeName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getSQLTypeName</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the SQL type name of the SQL structured type
 that this 
 <code>Struct</code>
 object represents.
 </dd>
<dt><b>Returns</b></dt>
<dd>the name of the SQL type.
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAttributes" class="membertitle">getAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; any &gt;</td>
</tr>
<tr>
<td valign="top"><b>getAttributes</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a></td>
<td valign="bottom">&nbsp;typeMap )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>produces the ordered values of the attributes of the SQL 
 structured type that this 
 <code>Struct</code>
 object represents. 
 </dd>
<dd><p>
 This method uses the given type map for customizations of the type 
 mappings. If there is no entry in the given type map that matches or 
 the given type map is 
 <b>NULL</b>
 , the structured type that this 
 <code>Struct</code>
 object represents, the driver uses 
 the connection type mapping. 
 </dd>
<dt><b>Parameter typeMap</b></dt>
<dd>is a map object that contains mappings of SQL type names to 
 services. If the 
 <code>typeMap</code>is
 <b>NULL</b>
 , the type-map 
 associated with the connection for customizations of the type-mappings 
 is used. 
 </dd>
<dt><b>Returns</b></dt>
<dd>an array containing the ordered attribute values. 
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>