osSetEvent function

osSetEvent function

Declaration:

BOOL osSetEvent(
  HANDLE Handle
);

Parameters:

Handle

The handle to the event object to be signaled.

Return value:

Returns TRUE on success or FALSE on failure. Call the osGetLastError function to obtain extended error information.

Description:

This function transitions the state of the specified event object to signaled.

Setting an event allows tasks currently waiting on the object to resume execution, depending on the event type (manual-reset or auto-reset) and task priority. For detailed information regarding event synchronization behavior, please refer to the Event Objects section.

This function is available only when the OS_USE_EVENT configuration constant is set to 1.

Version:	1.0
Header file:	OS_Event.h (include OS_API.h)
See also:	BOOL, events, FALSE, HANDLE, OS_USE_EVENT, osCreateEvent, osGetLastError, osResetEvent, TRUE

SpaceShadow documentation

About SpaceShadow products
Architecture dependencies
- Creating a port files
  - API File Template
  - Types File Template
  - Time management
  - Context switching
    - Functions
    - Types
  - Constants
  - Modifiers
    - CALLBACK
    - FAR
    - INLINE
    - NEAR
  - Configuration
    - AR_USE_64_BIT
    - AR_USE_DEINIT_FUNC
  - Functions
    - arDeinit
    - arInit
  - Macros
    - AR_MEMORY_ALIGN_UP
    - AR_UNUSED_PARAM
  - Types
    - BOOL
    - INDEX
    - INT8
    - INT16
    - INT32
    - INT64
    - LONG
    - PSTR
    - PVOID
    - SIZE
    - UINT8
    - UINT16
    - UINT32
    - UINT64
    - ULONG
- Ports
  - ARM
    - Generic ARM
    - AT91SAM7S
  - 80x86
    - 80x86 Real Mode
  - Virtual Devices
    - WIN32
Standard Library
Operating System Kernel