niSync_close

C Function Prototype

ViStatus niSync_close (ViSession vi);

Purpose

Ends an NI-Sync instrument driver session and frees the device for other operations.

You must use this function any time you begin a session using niSync_init. This function clears or disables any generated clocks, future time events, and timestamp triggers on the associated device.

Note Note  
  • If the session is locked, you must unlock the session before calling niSync_close.
  • After calling niSync_close, you cannot use the instrument driver again until you call niSync_init.
  • If any clocks have been created with niSync_CreateClock in the context of this session and have not been cleared, this function clears them. If any future time events have been created with niSync_CreateFutureTimeEvent in the context of this session and have not occurred or been cleared, this function clears them. If any timestamp triggers have been enabled with niSync_EnableTimeStampTrigger in the context of this session and have not been disabled, this function clears them.

Parameters

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

Return Values