niSync_SetAttributeViString

C Function Prototype

ViStatus niSync_SetAttributeViString (ViSession vi, ViConstString terminalName, ViAttr attributeID, ViConstString attributeValue);

Purpose

This function sets the value of a ViString attribute.

This instrument driver contains high-level functions that set most of the instrument attributes. It is best to use the high-level driver functions as much as possible. They handle order dependencies and multithread locking for you. In addition, they perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.

Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.

Parameters

Name Type Description
vi ViSession The session handle that you obtain from niSync_init. The handle identifies a particular instrument session.

activeItem ViConstString This parameter is ignored for most attributes. For those attributes that are specific to a given item or terminal, the item or terminal's name, for example, NISYNC_VAL_PFI0, must be specified.

Default Value: ""

attributeID ViAttr This parameter specifies the ID of the attribute you want to set.

attributeValue ViConstString Pass the value to which you want to set the attribute.

Note  Some of the values might not be valid depending on the current settings of the instrument session.


Default Value: none

Return Values