<html> <head> <title>Methods of Class OPropertyArrayHelper</title> <link rel="stylesheet" type="text/css" href="../../../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../../../index.html">Overview</a> </td> <td class="navimain"> <a href="../index.html">Namespace</a> </td> <td class="navimain"> <a href="../c-OPropertyArrayHelper.html">Class</a> </td> <td class="navimain"> <a href="../../../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../../../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"></table> <hr> <div class="title"><h2>Methods of Class OPropertyArrayHelper</h2> </div><hr> <dl class="member"> <dt class="member"><a name="OPropertyArrayHelper-3290"> </a>OPropertyArrayHelper</dt> <dd class="member"><dl> <dt class="simple"> <strong>OPropertyArrayHelper</strong>(</dt> <dd><table class="param-table"> <tr> <td>::com::sun::star::beans::<a href="../../../../../common/ref/com/sun/star/beans/Property.html">Property</a> * </td> <td> pProps,</td> </tr> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a></td> <td>nElements,</td> </tr> <tr> <td><a href="../../t-sal_Bool.html">sal_Bool</a></td> <td>bSorted = sal_True ) throw();</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Create an object which supports the common property interfaces. </pre></dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pProps</td> <td><pre><pre>array of properties The array pProps should be sorted. </pre></pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">nElements</td> <td><pre><pre>is the number of properties in the pProps structure. </pre></pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">bSorted</td> <td><pre><pre>indicates that the elements are sorted. </pre></pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="OPropertyArrayHelper-3291"> </a>OPropertyArrayHelper</dt> <dd class="member"><dl> <dt class="simple"> <strong>OPropertyArrayHelper</strong>(</dt> <dd><table class="param-table"> <tr> <td>const ::com::sun::star::uno::<a href="../../com/sun/star/uno/c-Sequence.html">Sequence</a>< ::com::sun::star::beans::Property > & </td> <td> aProps,</td> </tr> <tr> <td><a href="../../t-sal_Bool.html">sal_Bool</a></td> <td>bSorted = sal_True ) throw();</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Create an object which supports the common property interfaces. </pre></dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">aProps</td> <td><pre><pre>sequence of properties which are supported by this helper. The sequence aProps should be sorted. </pre></pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">bSorted</td> <td><pre><pre>indicates that the elements are sorted. </pre></pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="getCount-3292"> </a>getCount</dt> <dd class="member"><dl> <dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>getCount</strong>() throw();</dt> <dd><table class="param-table"></table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Return the number of properties. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="fillPropertyMembersByHandle-3293"> </a>fillPropertyMembersByHandle</dt> <dd class="member"><dl> <dt class="simple">virtual <a href="../../t-sal_Bool.html">sal_Bool</a> <strong>fillPropertyMembersByHandle</strong>(</dt> <dd><table class="param-table"> <tr> <td>::rtl::<a href="../../rtl/c-OUString.html">OUString</a> * </td> <td> pPropName,</td> </tr> <tr> <td><a href="../../t-sal_Int16.html">sal_Int16</a> *</td> <td>pAttributes,</td> </tr> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a></td> <td>nHandle );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Return the property members Name and Attribute from the handle nHandle. </pre></dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">nHandle</td> <td><pre><pre>the handle of a property. If the values of the handles are sorted in the same way as the names and the highest handle value is getCount() -1, than it is only an indexed acces to the property array. Otherwise it is a linear search through the array. </pre></pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pPropName</td> <td><pre><pre>is an out parameter filled with property name of the property with the handle nHandle. May be NULL. </pre></pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">rAttributes</td> <td><pre><pre>is an out parameter filled with attributes of the property with the handle nHandle. May be NULL. </pre></pre></td> </tr> </table> </dd> <dt>Return</dt> <dd><pre>True, if the handle exist, otherwise false. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="getProperties-3294"> </a>getProperties</dt> <dd class="member"><dl> <dt class="simple">virtual ::com::sun::star::uno::<a href="../../com/sun/star/uno/c-Sequence.html">Sequence</a>< ::com::sun::star::beans::Property > <strong>getProperties</strong>(</dt> <dd><table class="param-table"> <tr> <td>void </td> <td> );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Return the sequence of properties. The sequence is sorted by name. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="getPropertyByName-3295"> </a>getPropertyByName</dt> <dd class="member"><dl> <dt class="simple">virtual ::com::sun::star::beans::<a href="../../../../../common/ref/com/sun/star/beans/Property.html">Property</a> <strong>getPropertyByName</strong>(</dt> <dd><table class="param-table"> <tr> <td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> & </td> <td> rPropertyName )</td> </tr> <tr> <td/><td> throw( ::com::sun::star::beans::<a href="../../../../../common/ref/com/sun/star/beans/UnknownPropertyException.html">UnknownPropertyException</a> );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Return the property with the name rPropertyName. </pre></dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">rPropertyName</td> <td><pre><pre>the name of the property. </pre></pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="hasPropertyByName-3296"> </a>hasPropertyByName</dt> <dd class="member"><dl> <dt class="simple">virtual <a href="../../t-sal_Bool.html">sal_Bool</a> <strong>hasPropertyByName</strong>(</dt> <dd><table class="param-table"> <tr> <td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> & </td> <td> rPropertyName );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Return true if the property with the name rPropertyName exist, otherwise false. </pre></dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">rPropertyName</td> <td><pre><pre>the name of the property. </pre></pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="getHandleByName-3297"> </a>getHandleByName</dt> <dd class="member"><dl> <dt class="simple">virtual <a href="../../t-sal_Int32.html">sal_Int32</a> <strong>getHandleByName</strong>(</dt> <dd><table class="param-table"> <tr> <td>const ::rtl::<a href="../../rtl/c-OUString.html">OUString</a> & </td> <td> rPropertyName );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Return the handle of the property with the name rPropertyName. If the property does not exist -1 is returned. </pre></dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">rPropertyName</td> <td><pre><pre>the name of the property. </pre></pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="fillHandles-3298"> </a>fillHandles</dt> <dd class="member"><dl> <dt class="simple">virtual <a href="../../t-sal_Int32.html">sal_Int32</a> <strong>fillHandles</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-sal_Int32.html">sal_Int32</a> * </td> <td> pHandles,</td> </tr> <tr> <td>const ::com::sun::star::uno::<a href="../../com/sun/star/uno/c-Sequence.html">Sequence</a>< ::rtl::OUString > &</td> <td>rPropNames );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagyes">YES</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd><pre>Fill the array with the handles of the properties. </pre></dd> <dt>Return</dt> <dd><pre>the handles of the names from the pHandles array. -1 indicates an unknown property name. </pre></dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="init-3300"> </a>init</dt> <dd class="member"><dl> <dt class="simple">void <strong>init</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="../../t-sal_Bool.html">sal_Bool</a> </td> <td> bSorted ) throw();</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> </tr> </table> <br> </dd> <dd class="member"/></dl> <hr> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-cppref" --> </body> </html>