SNIP_CLASSIC_OS_SECTION_8_4_17_IncrementCounter

8.4.17 IncrementCounter [SWS_Os_00399] Definition of API function IncrementCounter ⌈ Service Name IncrementCounter Syntax StatusType IncrementCounter ( CounterType CounterID ) Service ID [hex] 0x0f Sync/Async Synchronous Reentrancy Reentrant Parameters (in) CounterID The Counter to be incremented Parameters (inout) None Parameters (out) None Return value StatusType E_OK: No errors E_OS_ID (only in EXTENDED status): The CounterID was not valid or counter is implemented in hardware and can not be incremented by software Description This service increments a software counter. Available via Os.h ⌋ [SWS_Os_00285] Upstream requirements: SRS_BSW_00323 ⌈If the input parameter <CounterID> in a call of IncrementCounter is not valid OR the Counter is a hardware Counter, IncrementCounter shall return E_OS_ID.⌋ [SWS_Os_00286] Upstream requirements: SRS_Os_11020 ⌈If the input parameter of IncrementCounter is valid, IncrementCounter shall increment the Counter <CounterID> by one (if any alarm connected to this Counter expires, the given action, e.g. Task activation, is done) and shall return E_OK.⌋ [SWS_Os_00321] Upstream requirements: SRS_Os_11020 ⌈If in a call of IncrementCounter an error happens during the execution of an alarm action, e.g. E_OS_LIMIT caused by a Task activation, IncrementCounter shall call the error hook(s), but the IncrementCounter service itself shall return E_OK.⌋ [SWS_Os_00529] Upstream requirements: SRS_Os_11020 ⌈Caveats of IncrementCounter: If called from a Task, rescheduling may take place.⌋ [SWS_Os_00530] Upstream requirements: SRS_Os_11016 ⌈Availability of IncrementCounter: Available in all Scalability Classes.⌋