vdsHashMap.h File Reference
Detailed Description
This file provides the API needed to access a VDSF hash map.Hash maps use unique keys - the data items are not sorted.
#include <vdsf/vdsCommon.h>
Include dependency graph for vdsHashMap.h:
This graph shows which files directly or indirectly include this file:
Functions | |
VDSF_EXPORT int | vdsHashMapClose (VDS_HANDLE objectHandle) |
Close a Hash Map. | |
VDSF_EXPORT int | vdsHashMapDelete (VDS_HANDLE objectHandle, const void *key, size_t keyLength) |
Remove the data item identified by the given key from the hash map. | |
VDSF_EXPORT int | vdsHashMapGet (VDS_HANDLE objectHandle, const void *key, size_t keyLength, void *buffer, size_t bufferLength, size_t *returnedLength) |
Retrieve the data item identified by the given key from the hash map. | |
VDSF_EXPORT int | vdsHashMapGetFirst (VDS_HANDLE objectHandle, void *key, size_t keyLength, void *buffer, size_t bufferLength, size_t *retKeyLength, size_t *retDataLength) |
Iterate through the hash map. | |
VDSF_EXPORT int | vdsHashMapGetNext (VDS_HANDLE objectHandle, void *key, size_t keyLength, void *buffer, size_t bufferLength, size_t *retKeyLength, size_t *retDataLength) |
Iterate through the hash map. | |
VDSF_EXPORT int | vdsHashMapInsert (VDS_HANDLE objectHandle, const void *key, size_t keyLength, const void *data, size_t dataLength) |
Insert a data element in the hash map. | |
VDSF_EXPORT int | vdsHashMapOpen (VDS_HANDLE sessionHandle, const char *hashMapName, size_t nameLengthInBytes, VDS_HANDLE *objectHandle) |
Open an existing hash map (see vdsCreateObject to create a new object). | |
VDSF_EXPORT int | vdsHashMapReplace (VDS_HANDLE objectHandle, const void *key, size_t keyLength, const void *data, size_t dataLength) |
Replace a data element in the hash map. | |
VDSF_EXPORT int | vdsHashMapStatus (VDS_HANDLE objectHandle, vdsObjStatus *pStatus) |
Return the status of the hash map. |
Last updated on April 07, 2008.