Getchannelpolarization; Iszerolossdone - JDS Uniphase SWS15100 User Manual

getChannelPolarization

Function Description
Purpose The getChannelPolarization function retrieves the polarization of the trace for
the specified channel in cache memory. Note: This function returns the last
polarization for specified channel, the last time any data was collected for the
channel. To find the latest polarization, use getTracePolarization instead.
C prototype int getChannelPolarization( unsigned short chID, short *polar );
VB prototype Declare Function getChannelPolarization Lib "SWS15100" ( ByVal ChID%,
ByRef polar% ) As Long
Input Unsigned short chID:
Channel ID for which polarization is sought.
Output short *polar:
This is a set of integers defined as: { S0 = 0, S1 = 1, S2 = 2, S3 = 3, S4 = 4,
POLARIZATION_END_MARKER = 5 }.
Return Value When there is no error, the function returns zero.
When there is an error, the return value contains the error number.

isZeroLossDone

Function Description
Purpose The isZeroLossDone function is used to check if a zero loss reference has
been performed for the specified polarization on the specified channel.
C prototype int isZeroLossDone( unsigned short chID, short polar, char *timeStamp )
VB prototype Declare Function isZeroLossDone Lib "SWS15100" (ByVal chID%, ByVal
polar%, ByVal timeStamp$) As Long
Input unsigned short chID:
This is the channel to be checked.
short polar:
This is the polarization state for which the user checks for zero loss reference.
Output char *timeStamp:
This is the time of the last zero loss reference for the specified polarization.
Return Value When there is a zero loss reference done for the specified polarization, the
return value is 1 (TRUE).
When there is no zero loss reference done for the specified polarization, the
return value is 0 (FALSE).
When there is an error, the return value contains the error number.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com
Programming Guide – 141