Nios® V Processor Software Developer Handbook

ID 743810
Date 5/26/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

13.1.1.14. alt_alarm_stop()

Prototype

void alt_alarm_stop (alt_alarm* alarm)

Commonly Called By

C/C++ programs

Device drivers

Thread-safe

Yes.

Available from ISR

Yes.

Include

<sys/alt_alarm.h>

Description

You can call the alt_alarm_stop() function to cancel an alarm previously registered by a call to alt_alarm_start(). The input argument is a pointer to the alarm structure in the previous call to alt_alarm_start().

On return the alarm is canceled, if it is still active.

Return

--