wvh_list_append

Appends new elements to an existing PV-WAVE LIST variable.

C Usage

long wvh_list_append(list_wvh, wvh_array, n_new)

WVH list_wvh 

WVH *wvh_array 

int n_new

Input Parameters

list_wvh—A PV-WAVE variable handle for an existing PV-WAVE LIST variable to which the new elements will be appended.

wvh_array—An array of variable handles for existing PV-WAVE variables to append to the LIST.

n_new—The number of new elements to append to the LIST.

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, etc.) 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 LIST elements must also exist in your PV-WAVE session, either retrieved by your C routine or created using the wave_assign_* routines.

The new LIST elements are appended to the LIST in the order they appear in the wvh_array.

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.