Programmer Guide > Creating an OPI Option > wvh_asarr_element
  

wvh_asarr_element
Retrieve a copy of an element in an existing PV-WAVE associative array.
C Usage
WVH wvh_asarr_element(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) representing the key for the element you wish to retrieve.
Returned Value
Success: Returns a new WVH for a copy of the desired element.
Failure: Returns NULL.
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.
The wvh_asarr_element routine returns a WVH for a new PV-WAVE variable which is a copy of the specified ASARR element. You may use any of the wvh_* routines to query or modify this variable. Modifying this variable does not affect the original ASARR element. If you wish to modify the ASARR itself, modify the returned WVH and use wave_assign_asarr to place the modified variable in the ASARR.
wvh_asarr_element currently supports only the C language interface.
For more information and example usage, see the example OPI in the wave/demo/interapp/opilist-1_0 directory.
For more general information about creating PV-WAVE variables in your C routine, see the documentation for the wave_assign_* routines.

Version 2017.1
Copyright © 2019, Rogue Wave Software, Inc. All Rights Reserved.