osSemaphoreAcquire() function

Acquire a Semaphore token or timeout if no tokens are available.

Syntax

Show:

Summary

Declaration

from cmsis_os2.h:621

osStatus_t osSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t timeout);

Arguments

Argument

Description

semaphore_id

semaphore ID obtained by osSemaphoreNew.

timeout

CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

Return value

status code that indicates the execution status of the function.

Examples

osSemaphoreAcquire() is referenced by 1 libraries and example projects:

Libraries

cmsis_rtos_threadx

References

from 0/1 examples

Code

Location

osStatus_t osSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t timeout);

cmsis_os2.h:621

Call Tree

from 0/1 examples

osSemaphoreAcquire() calls 1 function:

osSemaphoreAcquire()

__get_IPSR()

Data Use

from 0/1 examples

osSemaphoreAcquire() reads 4 variables:

osStatus_t::osOK

osStatus_t::osErrorTimeout

osStatus_t::osErrorResource

osStatus_t::osErrorParameter

osSemaphoreAcquire()

Class Tree

from 0/1 examples

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

Implementations

from 0/1 examples

All items filtered out

Instances

from 0/1 examples

Lifecycle

from 0/1 examples

All items filtered out