wvh_is_askey

Tests whether or not a specified key exists in an existing PV-WAVE associative array variable.

C Usage

long wvh_is_askey(asarr_wvh, key)

WVH asarr_wvh

char *key

Input Parameters

asarr_wvh—A PV-WAVE variable handle for an existing PV‑WAVE ASARR variable.

key—A string (pointer to a character array) containing the key you wish to test.

Returned Values

TRUE(1): If key exists in the associative array.

FALSE(0): If key does not exist in the associative array.

Discussion

The PV-WAVE ASARR variable you pass in must already exist in your PV‑WAVE session, either retrieved by your C routine or created by wave_assign_asarr.

wvh_is_askey currently supports only the C language interface.

For more information and example usage, see the example OPI in the $WAVE_DIR/demo/interapp/option directory.

For more general information about creating PV-WAVE variables in your C routine, see the documentation for the wave_assign_* routines.