Admin Production ni-theme
Current Publication

HashTableClear

LabWindows/CVI

HashTableClear

int HashTableClear (HashTableType table);

Purpose

Clears all key-value associations in the hash table.

If you enable table shrinking, LabWindows/CVI resizes the table to half its original size.

Note Note  The table never shrinks below the size originally allocated by HashTableCreate. Resizing can be very slow because it requires rehashing all keys stored in the table.

Parameters

Input
Name Type Description
table HashTableType Hash table to clear.

Return Value

Name Type Description
status int Returns a value indicating if the function was successful.

A negative number means an error occurred.

For a detailed error message, pass the returned value to GetGeneralErrorString.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 8.5 and later