wvh_list_replace
Replaces an element of an existing PV-WAVE LIST variable.
C Usage
long wvh_list_replace(list_wvh, new_wvh, index)
WVH list_wvh
WHH new_wvh
int index
Input Parameters
list_wvh—The PV-WAVE variable handle for an existing LIST variable.
new_wvh—A PV-WAVE variable handle for the PV-WAVE variable you wish to place in the LIST.
index—The position at which the new element should be placed in the LIST. The index must be in the valid range for the provided LIST variable (0 to wvh_nelems(LIST_WVH)–1).
Returned Status
OPI_SUCCESS—Successful assignment occurred.
OPI_FAILURE—The arguments are invalid or inconsistent.
OPI_DO_NOT_PROCEED—Catastrophic errors occurred and execution should not continue. The calling C-code should do its cleaning up (free malloc’s space, free handles, and so forth) and return to its caller immediately.
Discussion
The PV-WAVE LIST variable you wish to modify must already exist in your PV-WAVE session, either retrieved by your C routine or created by wave_assign_list.
The new PV-WAVE variable must also exist in your PV-WAVE session, either retrieved by your C routine or created using the wave_assign_* routines.
wvh_list_replace 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.
