NI-Sync C API Reference

niSync_EnableIRIGTimestamping

  • Updated2023-02-21
  • 1 minute(s) read

C Function Prototype

ViStatus _VI_FUNC niSync_EnableIRIGTimestamping (ViSession vi, ViInt32 irigType, ViConstString terminalName);

Purpose

Enables timestamping of IRIG decodes synchronized to the board time associated with the specified instrument handle. The terminal associated with this timestamp cannot be used for other operations until timestamping is disabled with niSync_DisableIRIGTimestamping or the session is closed with niSync_close.

Note Note  This attribute is supported only on certain targets. Refer to Target Support for Timing Attributes and Functions to determine whether or not this attribute is supported on your target.

Parameters

Name Type Description
vi ViSession The session handle that you obtain from niSync_init. The handle identifies a particular instrument session.
irigType ViInt32 This attribute specifies the type of IRIG output generated by the external IRIG source.

Valid Values:
NISYNC_VAL_IRIG_TYPE_IRIGB_DC
NISYNC_VAL_IRIG_TYPE_IRIGB_AM
activeItem viConstString This attribute specifies the terminal that contains the external IRIG source you would like to timestamp.

Return Values

Log in to get a better experience