wvh_name

PV-WAVE Foundation > Programmer Guide > Creating an OPI Option > wvh_name

wvh_name

Returns the variable name of a Wave variable handle.

C Usage

char *wvh_name(wvh)

WVH wvh;

FORTRAN Usage

INTEGER*4 LF_WVH_NAME(l_wvh, wave_variable)

INTEGER*4 l_wvh

CHARACTER*31 wave_variable

64-bit UNIX FORTRAN Usage

INTEGER*8 LF_WVH_NAME(l_wvh, wave_variable)

INTEGER*8 l_wvh

CHARACTER*31 wave_variable

Input Parameters

wvh—The Wave variable handle of the PV‑WAVE variable.

Returned Value—C

Returns a pointer to the PV‑WAVE variable name. NULL is returned on failure.

note

For maximum speed and space efficiency, this function returns a pointer to a string stored internally in PV‑WAVE. DO NOT modify the string in any way. Any modification of the string pointed to by this returned value may cause PV‑WAVE to crash.

Unnamed variables do have a name string, but it is an internal identifier that can not be recognized at the PV‑WAVE command line.

Returned Value—FORTRAN

The variable name is returned in the wave_variable string.

The function returns –1 on failure, if l_wvh is not a valid Wave variable handle.