@CHIP-RTOS C Library - RTOS API

RTX_Get_EventGroup_State

Read current events on a group.

int RTX_Get_EventGroup_State ( unsigned int id,
                               unsigned int far *event );

Parameters

id

Event group ID produced by RTX_Create_EventGroup call.

event

Output parameter, pointer to 16 bit location to receive the current state of the event flags.

Return Value

0 on success else error code (invalid group ID).

Comments

This function may be used by any program thread to acess the event group's current flag values.

See Also

RTX_Create_EventGroup        RTX_Signal_Events        RTX_Get_Saved_Events

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Related Topics

RTX API   Overview

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00