<!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: get_keyword - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: get_keyword - 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: get_keyword - 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_get_keyword" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - get_keyword</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_get_certificate_info.html" title="get_certificate_info">Prev</a> | <a class="link" href="fn_get_keyword_ucase.html" title="get_keyword_ucase">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 class="selected" 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 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>get_keyword</h2>
<div class="refpurpose">Find a value in keyword vector</div>
<div class="funcsynopsis">
<span class="funcdef">
<span class="function">get_keyword</span>
</span>
(<span class="paramdef">
<span class="parameter">keyword</span> any</span>,
<span class="paramdef">
<span class="parameter">searched_array</span> vector</span>,
<span class="paramdefoptional">[<span class="optional">default</span> any]</span>,
<span class="paramdefoptional">[<span class="optional">no_copy</span> integer]</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
<span class="computeroutput">get_keyword</span> performs a case sensitive seek
for the occurrence of
<span class="computeroutput">keyword</span> from each even position of
<span class="computeroutput">searched_array</span>. If found,this returns the
element following the occurrence of the keyword.
If the keyword is not found this returns the default argument or NULL if the default is
not supplied.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">keyword – </span>
String key value to be searched in the searched_array at
even positions.
</div>
<div class="refsect2">
<span class="refsect2title">searched_array – </span>
An array of even length to be searched.
Each even position is a string to search. Each odd position
can be any value that may then be returned.
</div>
<div class="refsect2">
<span class="refsect2title">default – </span>
Any data to be returned if keyword is not matched in
the searched_array.
</div>
<div class="refsect2">
<span class="refsect2title">no_copy – </span>
By default no_copy is false (0). If passed as true (non-zero integer)
then the element to return is the original content of the array and the place
in the array from which the element came gets set to 0.
This must in some cases be true, for example when the data being retrieved is
not copyable, as in the case of a string output. While the default behavior is to
return a copy of the element get_keyword will return the element itself and then
set the place from which the element was retrieved to 0 if this argument is true.
</div>
</div>
<div class="refsect1title">Errors</div>
<p>
<a href="errors.html#datatypeerror">Parameter data type checking errors</a>
</p>
<table class="data">
<tr>
<th class="data">SQL Code</th>
<th class="data">Error Message</th>
<th class="data">Virtuoso Code</th>
</tr>
<tr>
<td class="data">
<a name="err22023" />
<span class="errorcode">22023</span>
</td>
<td class="data">get_keyword expects a vector of even length,
not of length <n></td>
<td class="data">SR057</td>
</tr>
</table>
<br />
<p />
<div class="refsect1">
<div class="refsect1title">Return Values</div>
<p>
<span class="computeroutput">get_keyword</span> returns the matched data if it
is found. Otherwise it returns the <span class="computeroutput">default</span>.
When no <span class="computeroutput">default</span> is defined, NULL is returned.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_get_keyword" />
<div class="example">
<div class="exampletitle">Sample calls</div>
<div>
<pre class="programlisting">get_keyword(2,vector(1,'primero',2,'segundo',
3,'tercero'),NULL) -> segundo
get_keyword('tercero',vector('primero',1,'segundo',
2,'tercero',3), 'NOT FOUND!')) -> 3
x := vector ('a', 2);
y := get_keyword ('a', x, -1, 1);
The first call returns 2
y := get_keyword ('a', x, -1, 1);
the second call returns 0 as the data was set to 0 by the previous call.
</pre>
</div>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_get_keyword_ucase.html">get_keyword_ucase</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
>
294
