# 22. Virtuoso Functions Guide - dict_list_keys

Chapter Contents | Prev | Next
Keyword Search:
www.openlinksw.com
docs.openlinksw.com
Book Home
Contents
Preface
Virtuoso Functions Guide
Administration
Aggregate Functions
Array Manipulation
BPEL APIs
Backup
Compression
Cursor
Date & Time Manipulation
Debug
Dictionary Manipulation
dict_duplicate
dict_get
dict_list_keys
dict_new
dict_put
dict_remove
dict_to_vector
Encoding & Decoding
File Manipulation
Free Text
Hashing / Cryptographic
LDAP
Locale
Mail
Miscellaneous
Number
Remote SQL Data Source
Replication
SOAP
SQL
String
Transaction
Type Mapping
UDDI
User Defined Types & The CLR
Virtuoso Java PL API
Virtuoso Server Extension Interface (VSEI)
Web Server & Internet
XML
XPATH & XQUERY
Functions Index

## dict_list_keys

Returns an array of all keys stored in the given dictionary.
vector dict_list_keys (inout dict dictionary, in destructive any);
Description

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 dictinct keys, when dependent parts are fake (typically zeroes). If the destructive parameter is nonzero 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 destructive parameter 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 nonzero as soon as the variable passed to the function as dict 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.

Parameters
dict – The dictionary to scan
destructive – Flag that indicates whether the dictionary can be cleaned during the operation.
Return Types

The function returns a vector.

See Also

dict_new

dict_put

dict_get

dict_remove

dict_duplicate

dict_to_vector