GtDio6xProbeGetContact

Applies To

GX5961

Purpose

Returns contact state of the Probe.

Syntax

GtDio6xProbeGetContact (nHandle, pbContact, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Session identifier:

     Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.

pbContact
PBOOL
Used to return the contact state of the Probe. A TRUE indicates that the probe is in contact with a conductive surface with a path to Ground.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

When a Probe is attached to the GX5961, it can be polled for contact status. The Probe can detect if it is in contact with a conductive surface that has a path to Ground. When contact is made, the LED on the Probe is illuminated and when there is no contact, the LED is extinguished. Each call to this function updates the status of the LED and returns the contact state via the pbContact parameter. Note that the Rail Voltages (VCC and VEE) must be present and the power relay must be closed.

Example

The following example gets the probe contact:

 

SHORT nStatus;

BOOL  bContact;

 

GtDio6xProbeGetContact(nHandle, &bContact, &nStatus);

if(bContact)

        printf(“The Probe has made contact”);

else

        printf(“The probe is not making contact”);

 

See Also

GtDio6xPowerSetSource, GtDio6xProbeGetData, GtDio6xGetErrorString