[][src]Function libeyelink_sys::eyelink_abort

pub unsafe extern "C" fn eyelink_abort() -> INT16

@ingroup setup_eyelink Places EyeLink tracker in off-line (idle) mode.

@remarks Use before attempting to draw graphics on the tracker display, transferring files, or closing link. Always call \c eyelink_wait_for_mode_ready() afterwards to ensure tracker has finished the mode transition. This function pair is implemented by the eyelink_exptkit library function \c set_offline_mode(). @return \c 0 if mode switch begun, else link error.

\b Example:

\code

#include 

eyecmd_printf("heuristic_filter = ON");
eyelink_abort();    // stop data flow
eyelink_wait_for_mode_ready(500); // wait till finished mode switch
\endcode

\sa \c eyelink_wait_for_mode_ready() and \c set_offline_mode()