wave_wsdh_from

Programmer Guide > Creating an OPI Option > wave_wsdh_from_name

wave_wsdh_from_name

Returns a Wave structure definition handle given the name of a PV‑WAVE structure variable.

note	Any Wave Variable Handle (WVH) or Wave Structure Definition Handle (WSDH) returned from such PV-WAVE OPI interface routines as wave_get_WVH(), wave_wsdh_from_WVH() or wsdh_element() must be freed by the calling routine via wave_free_WVH or wave_free_WSDH or resource leaks will develop.

C Usage

long wave_wsdh_from_name(struct_def_name, WSDHptr)

char *struct_def_name;

WSDH *WSDHptr;

FORTRAN Usage

INTEGER*4 LF_WAVE_WSDH_FROM_NAME(struct_def_name, l_wsdh)

CHARACTER*31 structure_def_name

INTEGER*4 l_wsdh

64-bit UNIX FORTRAN Usage

INTEGER*8 LF_WAVE_WSDH_FROM_NAME(struct_def_name, l_wsdh)

CHARACTER*31 structure_def_name

INTEGER*8 l_wsdh

Input Parameters

struct_def_name—A string name of a PV‑WAVE structure variable.

Output Parameters

WSDHptr—The Wave structure definition handle for struct_def_name.

Returned Value

If there is a PV‑WAVE structure definition with the given name, OPI_SUCCESS will be returned and a Wave structure definition handle will be returned in the WSDHptr argument. Otherwise, OPI_FAILURE will be returned. OPI_DO_NOT_PROCEED will be returned for catastrophic failures such as PV‑WAVE being unable to allocate memory or any other resource.

Discussion

Since PV‑WAVE structure definitions exist independently of PV‑WAVE structure variables, it is not necessary to have a Wave variable handle in order to access a structure definition.

To create a new PV‑WAVE structure definition, use the wave_execute function such as:

wave_execute('a = {new_struct, tag1:0, … }')

Version 2017.0