niTClk_SetAttributeViSession

NI-TClk Synchronization

niTClk_SetAttributeViSession

C Function Prototype

ViStatus niTClk_SetAttributeViSession (ViSession session, ViConstString channelName, ViAttr attributeId, ViSession value);

Purpose

Sets the value of an NI-TClk ViSession attribute.

niTClk_SetAttributeViSession is a low-level function that you can use to set the values of NI-TClk attributes.

NI-TClk contains high-level functions that set most of the attributes. It is best to use the high-level functions as much as possible.

Parameters

Name Type Description
session ViSession session references the sessions being synchronized.
channelName ViConstString Pass VI_NULL or an empty string, except for NITCLK_ATTR_SCRIPT_TRIGGER_MASTER_SESSION, for which you should specify scriptTrigger0, scriptTrigger1, scriptTrigger2, or scriptTrigger3. VI_NULL and the empty string are treated as scriptTrigger0 for NITCLK_ATTR_SCRIPT_TRIGGER_MASTER_SESSION.
attributeId ViAttr The ID of the attribute that you want to set.

Supported Attributes

NITCLK_ATTR_START_TRIGGER_MASTER_SESSION NITCLK_ATTR_REF_TRIGGER_MASTER_SESSION
NITCLK_ATTR_SCRIPT_TRIGGER_MASTER_SESSION
NITCLK_ATTR_PAUSE_TRIGGER_MASTER_SESSION

value ViSession The value for the attribute.

Return Value