<!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_iter_rewind - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: dict_iter_rewind - 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_iter_rewind - 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_iter_rewind" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - dict_iter_rewind</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_dict_iter_next.html" title="dict_iter_next">Prev</a> | <a class="link" href="fn_dict_list_keys.html" title="dict_list_keys">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 class="selected" href="fn_dict_iter_rewind.html">dict_iter_rewind</a> </div> <div> <a 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_iter_rewind</h2> <div class="refpurpose">Resets the iterator before fetching keys and values by dict_iter_next()</div> <div class="funcsynopsis"> <span class="funcdef"> <span class="function">dict_iter_rewind</span> </span> (<span class="paramdef">inout <span class="parameter">dict</span> dictionary</span>); </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p>The dictionary is always passed by reference, due to its (potentialy big) size. The reference variable contains not only pointer to the whole dictionary but also a forward-only iterator (a "cursor") that can be used to retrieve items of the dictionary one after the other. The function sets the iterator to the very first item of the dictionary.</p> </div> <div class="refsect1"> <div class="refsect1title">Parameters</div> <div class="refsect2"> <span class="refsect2title">dict – </span> The reference to a dictionary to use as an iterator </div> </div> <div class="refsect1"> <div class="refsect1title">Return Types</div> <p>The function returns an integer that is the expected number of items in the dictionary; the value may not match to the number of items retrieved later by dict_iter_next() if a dictionary is edited by some thread.</p> </div> <div class="refsect1"> <div class="refsect1title">Example</div> <a name="ex_dict_iter_rewind" /> <div class="example"> <div class="exampletitle">Simplest read throughout the dictionary.</div> <p>The procedure creates a dictionary, puts couple of items into it and then print them to the server's console</p> <div> <pre class="screen"> create function dict_iterator_test () { declare dict, dkey, dvalue any; dict := dict_new (10); dict_put (dict, 'a', 1); dict_put (dict, 'b', 2); dict_iter_rewind (dict); while (dict_iter_next (dict, dkey, dvalue)) dbg_obj_princ (' key is ' dkey, ', corresponding value is ', dvalue); } </pre> </div> </div> </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="fn_dict_list_keys.html">dict_list_keys</a> </p> <p> <a href="">dict_destructive_list_rnd_keys</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>