<!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: dict_list_keys - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: dict_list_keys - 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: dict_list_keys - 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_dict_list_keys" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - dict_list_keys</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_dict_iter_rewind.html" title="dict_iter_rewind">Prev</a> | <a class="link" href="fn_dict_new.html" title="dict_new">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 href="functions.html#array">Array Manipulation</a>
</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 class="selected" href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div class="selected">
<div>
<a href="fn_dict_dec_or_remove.html">dict_dec_or_remove</a>
</div>
<div>
<a href="fn_dict_duplicate.html">dict_duplicate</a>
</div>
<div>
<a href="fn_dict_get.html">dict_get</a>
</div>
<div>
<a href="fn_dict_inc_or_put.html">dict_inc_or_put</a>
</div>
<div>
<a href="fn_dict_iter_next.html">dict_iter_next</a>
</div>
<div>
<a href="fn_dict_iter_rewind.html">dict_iter_rewind</a>
</div>
<div>
<a class="selected" href="fn_dict_list_keys.html">dict_list_keys</a>
</div>
<div>
<a href="fn_dict_new.html">dict_new</a>
</div>
<div>
<a href="fn_dict_put.html">dict_put</a>
</div>
<div>
<a href="fn_dict_remove.html">dict_remove</a>
</div>
<div>
<a href="fn_dict_size.html">dict_size</a>
</div>
<div>
<a href="fn_dict_to_vector.html">dict_to_vector</a>
</div>
</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>dict_list_keys</h2>
<div class="refpurpose">Returns an array of all keys stored in the given dictionary.</div>
<div class="funcsynopsis">
<span class="funcdef">vector <span class="function">dict_list_keys</span>
</span>
(<span class="paramdef">inout <span class="parameter">dict</span> dictionary</span>,
<span class="paramdef">in <span class="parameter">destructive</span> any</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>The function returns an array of all keys stored in the given dictionary, ignoring dependent parts of key-value pairs.
This is especially useful when dictionary is used to form a set of distinct keys, when dependent parts are fake (typically zeroes).
If the <span class="computeroutput">destructive</span> parameter is 1 or 2 then the function may avoid copying of keys to the resulting array
by moving them out from the dictionary. This is faster but the dictionary will become empty at the end of operation.
The <span class="computeroutput">destructive</span> parameter equal to 1 does not have any effect if the dictionary is used as a value of more than one variable.
Thus it is safe to make this parameter equal to 1 as soon as the variable passed to the function as <span class="computeroutput">dict</span> is no longer in use after
the function call and there's no need to inspect the whole program to check if other variables may be affected.
The parameter equal to 2 ignores the presence of multiple variables so the operation may cause unexpected results in other fragments of code that share the dictionary.
</p>
<p>
The created array can not be longer than the system limit and even if it is below limit but longer than hundreds of thousands items then memory allocation can be inefficient.
If the dictionary can be large and it is possible to process the content of the dictionary in parts, consider using
<a href="">dict_destructive_list_rnd_keys</a>() instead.
</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">dict – </span>
The dictionary to scan
</div>
<div class="refsect2">
<span class="refsect2title">destructive – </span>
Flag that indicates whether the dictionary can be cleaned during the operation (0 = never clean, 1 = only if there is no other variables, 2 = clean unconditionally).
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>The function returns a vector.</p>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_dict_new.html">dict_new</a>
</p>
<p>
<a href="">dict_zap</a>
</p>
<p>
<a href="fn_dict_put.html">dict_put</a>
</p>
<p>
<a href="fn_dict_get.html">dict_get</a>
</p>
<p>
<a href="fn_dict_remove.html">dict_remove</a>
</p>
<p>
<a href="fn_dict_inc_or_put.html">dict_inc_or_put</a>
</p>
<p>
<a href="fn_dict_dec_or_remove.html">dict_dec_or_remove</a>
</p>
<p>
<a href="fn_dict_size.html">dict_size</a>
</p>
<p>
<a href="fn_dict_duplicate.html">dict_duplicate</a>
</p>
<p>
<a href="fn_dict_to_vector.html">dict_to_vector</a>
</p>
<p>
<a href="">dict_destructive_list_rnd_keys</a>
</p>
<p>
<a href="fn_dict_iter_rewind.html">dict_iter_rewind</a>
</p>
<p>
<a href="fn_dict_iter_next.html">dict_iter_next</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
>
251
