www.beck-ipc.com

@CHIP-RTOS C Library - RTOS API


RTX_Find_EventGroup

Find an event group by specified name tag and return the unique event group ID.

int RTX_Find_EventGroup ( unsigned int far *id_ptr,
                          const char far *name );

Parameters

id_ptr

Output parameter, pointer to where to put the event group ID if found.

name

Input parameter, pointer to 4 character name of event group to look for.

This name does not need to be zero terminated, but must contain 4 bytes.

Return Value

0 on success else error code.

Comments

If more than one event group exists with the specified name, this function will return the ID of one of these event groups.   Which event group is returned is indeterminant when the name is not unique.

See Also

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

    SC12SC13SC11SC1x3SC2x
    V1.00V1.00V1.00V0.90V1.00

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document