SYSNAME type
Declaration:
#if ((OS_SYS_OBJECT_MAX_NAME_LEN) <= 0UL)
  typedef INDEX SYSNAME;
#else
  typedef PSTR SYSNAME;
#endif
Description:

All system objects (with the exception of tasks) may be assigned an optional name. This name is defined during object creation and allows a task to open an existing object when the system-assigned handle is unknown. Since all operations performed on objects require a valid handle, the osOpen* functions (e.g., osOpenMutex) are used to retrieve the handle of a named object. Detailed information regarding this process can be found in the system objects management section.

By default, an object name is a string whose maximum length is determined by the OS_SYS_OBJECT_MAX_NAME_LEN configuration value. If this value is set to 0, integer identifiers of the INDEX type are used as names instead. To ensure portability across different configurations, names should always be passed to system functions using the SYSNAME type. This type is automatically resolved to either PSTR or INDEX based on the system configuration.

Version:1.0
Header file:OS_API.h
See also: INDEX, OS_SYS_OBJECT_MAX_NAME_LEN, PSTR, system objects management
SpaceShadow documentation