AMETEK Ls Series Driver Manual - Manual (Page 181)

IVI Driver Manual Lx / Ls Series
177
ciLxs_GetPhaseName
ViStatus ciLxs_GetPhaseName (ViSession instrumentHandle, ViInt32 index,
ViInt32 bufferSize,
ViChar _VI_FAR phaseName[]);
Purpose
This function returns the highest-level phase name that corresponds to
the specific driver phase string that is in the phase table at an index
you specify. By passing 0 for the buffer size, the caller can ascertain
the buffer size required to get the entire phase name string and then
call the function again with a sufficiently large buffer.
Parameter List
instrumentHandle
Variable Type ViSession
The ViSession handle that you obtain from the ciLxs_init or
ciLxs_InitWithOptions function. The handle identifies a particular
instrument session.
Default Value: None
index
Variable Type ViInt32
A 1-based index into the phase table.
Default Value: 1
bufferSize
Variable Type ViInt32
Pass the number of bytes in the ViChar array you specify for the
Channel Name parameter.
If the channel name, including the terminating NUL byte, contains
more bytes than you indicate in this parameter, the function copies
BufferSize - 1 bytes into the buffer, places an ASCII NUL byte at the
end of the buffer, and returns the buffer size you must pass to get
the entire value. For example, if the value is "123456" and the
Buffer Size is 4, the function places "123" into the buffer and
returns 7.
If you pass a negative number, the function copies the value to the
buffer regardless of the number of bytes in the value.
If you pass 0, you can pass VI_NULL for the Channel Name buffer