viUnmapTrigger

Agilent VISA.NET

viUnmapTrigger

Syntax

viUnmapTrigger(ViSession vi, ViInt16 trigSrc, ViInt16 trigDest);

Description

This operation can be used to map one trigger line to another. This operation is valid only on VXI Backplane (BACKPLANE) sessions.

This operation unmaps only one trigger mapping per call. If viMapTrigger was called multiple times on the same BACKPLANE resource and created multiple mappings for either trigSrc or trigDest, trigger mappings other than the one specified by trigSrc and trigDest remain in effect after this call completes.  

Parameters

Name

Dir

Type

Description

vi

IN

ViSession

Unique logical identifier to a session.

trigSrc

IN

ViInt16

Source line used in previous map.

trigDest

IN

ViInt16

Destination line used in previous map.

Special Values for trgSrc Parameter

Value

 

 

Action Description

VI_TRIG_ECL0 - VI_TRIG_ECL1

 

 

Unmap the specified VXI ECL trigger line.

VI_TRIG_PANEL_IN

 

 

Unmap the controller's front panel trigger input line.

VI_TRIG_PANEL_OUT

 

 

Unmap the controller's front panel trigger output line.

VI_TRIG_TTL0 - VI_TRIG_TTL7

 

 

Unmap the specified VXI TTL trigger line.

Special Values for trgDest Parameter

Value

 

 

Action Description

VI_TRIG_ALL

 

 

Unmap all trigger lines to which trigSrc is currently connected.

VI_TRIG_ECL0 - VI_TRIG_ECL1

 

 

Unmap the specified VXI ECL trigger line.

VI_TRIG_PANEL_IN

 

 

Unmap the controller's front panel trigger input line.

VI_TRIG_PANEL_OUT

 

 

Unmap the controller's front panel trigger output line.

VI_TRIG_TTL0 - VI_TRIG_TTL7

 

 

Unmap the specified VXI TTL trigger line.

Return Values 

Type ViStatus

This is the function return status. It returns either a completion code or an error code as follows.

Completion Codes

Description

VI_SUCCESS

Operation completed successfully.

Error Codes

Description

VI_ERROR_INV_LINE

One of the specified lines (trigSrc or trigDest) is invalid.

VI_ERROR_INV_SESSION
VI_ERROR_INV_OBJECT

The given session or object reference is invalid (both are the same value).

VI_ERROR_NSUP_LINE

One of the specified lines (trigSrc or trigDest) is not supported by this VISA implementation.

VI_ERROR_NSUP_OPER

The given vi does not support this function.

VI_ERROR_RSRC_LOCKED

Specified operation could not be performed because the resource identified by vi has been locked for this kind of access.

VI_ERROR_TRIG_MAPPED

The path from trigSrc to trigDest is not currently mapped.

See Also

BACKPLANE resource description