<!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: position - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: position - 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: position - 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_position" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - position</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_make_array.html" title="make_array">Prev</a> | <a class="link" href="fn_rowvector_digit_sort.html" title="rowvector_digit_sort">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 class="selected" href="functions.html#array">Array Manipulation</a> </div> <div class="selected"> <div> <a href="fn_aref.html">aref</a> </div> <div> <a href="fn_aset.html">aset</a> </div> <div> <a href="fn_concat.html">concat</a> </div> <div> <a href="fn_concatenate.html">concatenate</a> </div> <div> <a href="fn_dvector.html">dvector</a> </div> <div> <a href="fn_get_keyword.html">get_keyword</a> </div> <div> <a href="fn_get_keyword_ucase.html">get_keyword_ucase</a> </div> <div> <a href="fn_gvector_digit_sort.html">gvector_digit_sort</a> </div> <div> <a href="fn_gvector_sort.html">gvector_sort</a> </div> <div> <a href="fn_isarray.html">isarray</a> </div> <div> <a href="fn_make_array.html">make_array</a> </div> <div> <a class="selected" href="fn_position.html">position</a> </div> <div> <a href="fn_rowvector_digit_sort.html">rowvector_digit_sort</a> </div> <div> <a href="fn_serialize.html">serialize</a> </div> <div> <a href="fn_split_and_decode.html">split_and_decode</a> </div> <div> <a href="fn_tree_md5.html">tree_md5</a> </div> <div> <a href="fn_vector.html">vector</a> </div> <div> <a href="fn_vector_concat.html">vector_concat</a> </div> </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>position</h2> <div class="refpurpose">returns the index of an element within an array or string</div> <div class="funcsynopsis"> <span class="funcdef"> <span class="function">position</span> </span> (<span class="paramdef"> <span class="parameter">element</span> any</span>, <span class="paramdef"> <span class="parameter">array</span> any</span>, <span class="paramdef"> <span class="parameter">start_index</span> integer (optional, default 1)</span>, <span class="paramdef"> <span class="parameter">step</span> integer (optional, default 1)</span>); </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p>position returns the one-based index for the first occurrence of element within an <span class="computeroutput">array</span> or <span class="computeroutput">string</span>, beginning from offset start_index and iterating with step. If the second argument is a <span class="computeroutput">string</span>, the first argument must be a string with a single character. If the second argument is an array of <span class="computeroutput">any</span>, then depending of type of it's elements same type is expected as the first argument.</p> </div> <div class="refsect1"> <div class="refsect1title">Parameters</div> <div class="refsect2"> <span class="refsect2title">element – </span> <span class="computeroutput">any</span>, <span class="computeroutput">depends of type of elements in second argument</span>. </div> <div class="refsect2"> <span class="refsect2title">array – </span> <span class="computeroutput">array</span>, <span class="computeroutput">vector</span> or <span class="computeroutput">string</span>. </div> <div class="refsect2"> <span class="refsect2title">start_index – </span> <span class="computeroutput">integer</span> index beginning from 1; from where to start search. </div> <div class="refsect2"> <span class="refsect2title">step – </span> <span class="computeroutput">integer</span> the step between elements to be tested; default is 1 (every element) </div> </div> <div class="refsect1"> <div class="refsect1title">Return Values</div> <p>An <span class="computeroutput">integer</span> index in array starting from 1; if not found returns zero.</p> </div> <div class="refsect1title">Errors</div> <table class="data"> <tr> <th class="data">SQLState</th> <th class="data">Error Code</th> <th class="data">Error Text</th> <th class="data">Description</th> </tr> <tr> <td class="data"> <a name="err22003" /> <span class="errorcode">22003</span> </td> <td class="data"> <a name="errSR061" /> <span class="errorcode">SR061</span> </td> <td class="data"> <span class="errorname">position: expects a vector whose length is divisible by [step], not of length [actual len].</span> </td> <td class="data" /> </tr> <tr> <td class="data"> <a name="err22023" /> <span class="errorcode">22023</span> </td> <td class="data"> <a name="errSR000" /> <span class="errorcode">SR000</span> </td> <td class="data"> <span class="errorname">position expects an array or vector, not an arg of type %d.</span> </td> <td class="data" /> </tr> </table> <br /> <p /> <div class="refsect1"> <div class="refsect1title">Examples</div> <a name="ex_position_1" /> <div class="example"> <div class="exampletitle">Simple examples</div> <div> <pre class="screen"> SQL> select position ('b', 'Abacus'); callret VARCHAR _______________________________________________________________________________ 2 1 Rows. -- 3 msec. SQL> select position (2, vector ('Primero', null, 2, 3.333)); callret VARCHAR _______________________________________________________________________________ 3 1 Rows. -- 4 msec. SQL> select position ('a', 'babaab', 1, 2); ^--- matches 5-th as other 'a' are skipped as step is 2 chars callret INTEGER _______________________________________________________________________________ 5 1 Rows. -- 4 msec. </pre> </div> </div> </div> <div class="refsect1"> <div class="refsect1title">See Also</div> <p> <a href="fn_vector.html">vector</a> <a href="fn_aset.html">aset</a> <a href="fn_aref.html">aref</a> <a href="fn_ascii.html">ascii</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>