PxToStop()

Stop timeout (task service).

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxToStop (PxPe_t ToId);
ARGUMENTS
ToId

Timeout handler object id

RETURN VALUES
  • PXROS error code

ERROR CODES

PXERR_REQUEST_ILLEGAL

The caller is not the requester of the ToId object

PXERR_TO_ILLTO

ToId is not a valid timeout object

DESCRIPTION

PxToStop stops the timeout associated with ToId. This funcion can only be called from a task (not from a handler).

IMPLEMENTATION GUIDELINES
Before call
  • ToId must be a valid PXROS-HR timeout object created with a PxToRequest call (V). The validity of ToId may also be checked by the PxToIsValid macro (F).

After call
  • The function returns PXERR_NOERROR if the timeout could be stopped. Any other return value describes an error, which has to be interpreted (C).

Best Practice
  • No restrictions.

SEE ALSO
USAGE
#include "pxdef.h"

PxError_t Err = PxToStop(ToId);

if (Err != PXERR_NOERROR) {
    // Report error
}