CreateProbe

Connects a task to an instrument controller.

Synopsis

Item CreateProbe( Item Instrument, const char *Name, const TagArg *Tags )

Item CreateProbeVA( Item Instrument, const char *Name, uint32 tag1, ... )

Description

This function creates a Probe item that provides a fast connection between a task and one of an instrument's outputs. You can then call ReadProbe() to poll the value of output. When you finish with the probe item, you should call DeleteProbe() to deallocate the item.

If you plan to use a probe several times, the proper procedure is to call CreateProbe() once to create the item, call ReadProbe() several times, and then call DeleteProbe() when finished.

Arguments

Instrument: The item number of the instrument.

Name: The name of the Output.

Return Value

The function returns the item number of the probe if successful or an error code (a negative value) if an error occurs.

Implementation

Folio call implemented in Audio folio V24.

Associated Files

audio.h

Notes

This function is case-insensitive to the names of probes.