GxAoArbGetGroupClockEx

Purpose

Returns the specified group clock source information.

Applies

GX1632e

Syntax

GxAoArbGetGroupClockEx (nHandle, nGroup, pnSource, pdwParam, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX1632e board.
nGroup
SHORT
Group number:
0.   GXAO_GROUPA
1.   GXAO_GROUPB
2.   GXAO_GROUPC
3.   GXAO_GROUPD
pnSource
PSHORT
Returned clock source:
0.      GXAO_CLOCKSOURCE_INTERNAL
1.      GXAO_CLOCKSOURCE_EXTERNAL
2.      GXAO_CLOCKSOURCE_PXI0
3.      GXAO_CLOCKSOURCE_PXI1
4.      GXAO_CLOCKSOURCE_PXI2
5.      GXAO_CLOCKSOURCE_PXI3
6.      GXAO_CLOCKSOURCE_PXI4
7.      GXAO_CLOCKSOURCE_PXI5
8.      GXAO_CLOCKSOURCE_PXI6
9.      GXAO_CLOCKSOURCE_PXI7
10.   GXAO_CLOCKSOURCE_STAR_TRIGGER
11.   GXAO_CLOCKSOURCE_GROUPA
12.   GXAO_CLOCKSOURCE_STAR_A
13.   GXAO_CLOCKSOURCE_STAR_B
14.   GXAO_CLOCKSOURCE_DIO
15.   GXAO_CLOCKSOURCE_DIVIDER
16.   GXAO_CLOCKSOURCE_SOFTWARE
17.  GXAO_CLOCKSOURCE_FREQUENCY
pdwParam
PDWORD
Returned parameter.  Dependent upon the clock source selected.  See comments.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Default clock source is GXAO_CLOCKSOURCE_INTERNAL.  In this mode, each channel will hold its last programmed value at a static level.

GXAO_CLOCKSOURCE_GROUPA can only be used when nGroup is set to B, C, and D, using group A clock source will synchronizes all group channels to use the same clock source as group A.

GXAO_CLOCKSOURCE_DIVIDER uses a 10 MHz clock divided by 2^(N+1) where N is the input value dwParam.  Valid range is 6 to 26.

GXAO_CLOCKSOURCE_FREQUENCY allows the user to program the frequency in 1uS increments.  The frequency achieved is 1/N where N is the input value dwParam.  Valid range is 1 to 2^32-1.

Example

The following example returns the clock source and parameter for group D:

 

SHORT  nStatus, nClockSource;

DWORD  dwParam;

 

GxAoArbGetGroupClockEx (nHandle, GXAO_GROUPD, &nClockSource, &dwParam, &nStatus);

 

See Also

GxAoArbSetGroupClockEx, GxAoGetErrorString