NI-Sync C API Reference

niSync_EnableTimeStampTrigger

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

C Function Prototype

ViStatus _VI_FUNC niSync_EnableTimeStampTrigger (ViSession vi, ViConstString terminal, ViInt32 activeEdge);

Purpose

Creates a timestamp every time the signal of the specified trigger or clock changes. You can then read a single timestamp or multiple timestamps at a later point in the data flow.

You cannot use the input terminal specified in this function for other operations until you disable the timestamp trigger using niSync_DisableTimeStampTrigger or close the session with niSync_close. You can create timestamps for triggers, future time events, clocks created using niSync_CreateClock, and external devices.

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.
terminal ViConstString Specifies the terminal that contains the trigger signal you would like to timestamp.
activeEdge ViInt32 Specifies at what point in the trigger signal to record a timestamp in the software buffer.

Valid Values:
NISYNC_VAL_EDGE_RISING
NISYNC_VAL_EDGE_FALLING
NISYNC_VAL_EDGE_ANY

Return Values

Log in to get a better experience