untimeout(D3)

NAME
     untimeout - cancel previous timeout request

SYNOPSIS
     #include <sys/types.h>
     #include <sys/ddi.h>
     int untimeout(toid_t id);

   Arguments
     id        Non-zero identifier returned from a prior call to dtimeout(D3)
               or itimeout(D3).

DESCRIPTION
     untimeout cancels the pending timeout request specified by id.

   Return Values
     If the pending timeout was successfully canceled then a non-zero result
     is returned.  Otherwise zero is returned to indicate failure.

USAGE
     On uniprocessor systems, if untimeout is called while any function called
     by the pending timeout request is running, then there is no effect.

     Note that any function that runs as a result of a call to itimeout (or to
     dtimeout) cannot use untimeout to cancel itself.

     Possible reasons for untimeout to fail include that the timeout is
     currently executing or it has already finished executing.

   Level
     Base or Interrupt, with the following exception on multiprocessor
     systems:  For itimeout(D3) and dtimeout(D3), the untimeout can only be
     performed from interrupt levels less than, or equal to, the level
     specified when the function was scheduled.

   Synchronization Constraints
     Driver-defined basic locks, read/write locks, and sleep locks may not be
     held across calls to this function if these locks are contended by the
     function being canceled.

   Examples
     See unbufcall(D3) for an example of untimeout.

REFERENCES
     delay(D3), dtimeout(D3), itimeout(D3), unbufcall(D3)