<html> <head> <title>Struct OpenCommandArgument</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="OpenCommandArgument-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="#Elements" class="navisub">Elements' Summary</a></td> <td class="navisub"><a href="#ElementDetails" class="navisub">Elements' Details</a></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">ucb</a> :: </p> </td> </tr> <tr> <td class="title">struct OpenCommandArgument</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The argument for commands like "open", "update", and "synchronize". </dd> <dt><b>See also</b></dt> <dd><a href="XCommandProcessor.html">XCommandProcessor</a></dd> </dl> </td> </tr> </table> <hr> <a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Elements' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Mode">Mode</a></td> <td class="imsum_right">A mode. </td> </tr> <tr> <td class="imsum_left"><a href="#Priority">Priority</a></td> <td class="imsum_right">The command's priority, in the range <code>0</code> (highest) to <code>65535</code> (lowest). </td> </tr> <tr> <td class="imsum_left"><a href="#Sink">Sink</a></td> <td class="imsum_right">The data sink to write the contents into (supporting either ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XActiveDataSink.html">XActiveDataSink</a>, ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a> or ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XActiveDataStreamer.html">XActiveDataStreamer</a>). </td> </tr> <tr> <td class="imsum_left"><a href="#Properties">Properties</a></td> <td class="imsum_right">The properties, for that the values shall be provided by the <a href="DynamicResultSet.html">DynamicResultSet</a> returned by the command). </td> </tr> </table> <a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Elements' Details</td> </tr> <tr> <td class="imdetail"><a name="Mode" class="membertitle">Mode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Mode</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>A mode. </dd> <dd><p>The value can be one of the <a href="OpenMode.html">OpenMode</a> constants. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Priority" class="membertitle">Priority</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Priority</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The command's priority, in the range <code>0</code> (highest) to <code>65535</code> (lowest). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Sink" class="membertitle">Sink</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a> <b>Sink</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The data sink to write the contents into (supporting either ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XActiveDataSink.html">XActiveDataSink</a>, ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a> or ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XActiveDataStreamer.html">XActiveDataStreamer</a>). </dd> <dd><p>XActiveDataSink and XOutputStream give the caller read-only access to the contents. XActiveDataStreamer offers both read and write access to the contents. <p>If an XActiveDataSink is supplied, the implementation of the command needs to provide an implementation of an object implementing the interface ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>. It is highly recommended that this object also implements the interface ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XSeekable.html">XSeekable</a>, if this can be done without wasting resources (i.e. allocating huge memory buffers). The implementation object has to be supplied to the data sink. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Properties" class="membertitle">Properties</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/Property.html">Property</a> > <b>Properties</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The properties, for that the values shall be provided by the <a href="DynamicResultSet.html">DynamicResultSet</a> returned by the command). </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
