wave_wsdh_from_wvh
Returns a Wave structure definition handle for 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_wvh(wvh, WSDHptr)
WVH wvh;
WSDH *WSDHptr;
FORTRAN Usage
INTEGER*4 LF_WAVE_WSDH_FROM_WVH(l_wvh, l_wsdh)
INTEGER*4 l_wvh, l_wsdh
64-bit UNIX FORTRAN Usage
INTEGER*8 LF_WAVE_WSDH_FROM_WVH(l_wvh, l_wsdh)
INTEGER*8 l_wvh, l_wsdh
Input Parameters
wvh—A Wave variable handle of a named or unnamed PV‑WAVE structure variable.
Output Parameters
WSDHptr—A pointer to the Wave Structure Definition Handle for wvh.
Returned Values
If the PV‑WAVE variable exists and is of type structure, OPI_SUCCESS will be returned and a Wave structure definition handle will be returned in the WSDHptr argument. OPI_FAILURE will be returned if the Wave variable handle is invalid or the variable is not of type structure. OPI_DO_NOT_PROCEED will be returned for catastrophic failures such as PV‑WAVE being unable to allocate memory or any other resource.
