Agilent Technologies VXI E1439 - Manual (Page 86)

76
Agilent E1439 Programmer's Reference
Functions listed alphabetically
age1439_clock_fs
Provides the module with the frequency of an external sample clock. This description also
includes the query:
age1439_clock_fs_get
VXIplug&play Syntax
#include "age1439".h
ViStatus age1439_clock_fs(ViSession id, ViReal64 fs);
ViStatus age1439_clock_fs_get(ViSession id, ViPReal64 fsPtr);
Description
This command is applicable only when an external sample clock is used. It is an order-dependent
command and must be set after selecting the external sample clock.
When using an external sample clock or when a module is a non-master in a multi-module group,
the frequency of the ADC clock is unknown by the module. It is the responsibility of the
programmer to provide the correct frequency so that library functions dependent on fs operate
properly. This value has no effect if the module is not set up to use the external sample clock.
Parameters
id is the VXI instrument session pointer returned by the age1439_init function.
fs provides the module with the frequency of an external sample clock (from 10,000,000 to
103,000,000) connected to the Ext Clk TTL connector.
AGE1439_FS_MIN supplies the minimum external sample clock frequency.
AGE1439_FS_MAX supplies the maximum external sample clock frequency.
fsPtr points to the current value of the external sample clock frequency. If the Agilent E1439 is set to
the internal ADC clock, this query returns the value of that clock frequency. If the Agilent E1439
is set to the external clock, this query returns the last value entered via the age1439_clock_fs
function.
Return Value
AGE1439_SUCCESS indicates that a function was successful.
Values other than AGE1439_SUCCESS indicate an error condition or other important status
condition. To determine the error message, pass the return value to
“age1439_error_message” on
page 102 .
See Also
“Default values” on page 201 , “age1439_init” on page 132 , “age1439_clock_setup” on page 78 ,
“age1439_front_panel_clock_input” on page 131 , “age1439_ext_sample_sync” on page 104 ,
“Using clock and sync” in chapter 3