RTEMS 4.9.5 On-Line Library

Object Services OBJECT_GET_CLASS_INFORMATION - Obtain Class Information

RTEMS C User's Guide

27.4.16: OBJECT_GET_CLASS_INFORMATION - Obtain Class Information

CALLING SEQUENCE:

rtems_status_code rtems_object_get_class_information(
  uint32_t                            the_api,
  uint32_t                            the_class,
  rtems_object_api_class_information *info
);

DIRECTIVE STATUS CODES

RTEMS_SUCCESSFUL - information obtained successfully
RTEMS_INVALID_ADDRESS - info is NULL
RTEMS_INVALID_NUMBER - invalid api or the_class

If successful, the structure located at info will be filled in with information about the specified api/the_class pairing.

DESCRIPTION:

This service returns information about the object class indicated by the specified api and the_class. This structure is defined as follows:

typedef struct {
  rtems_id  minimum_id;
  rtems_id  maximum_id;
  uint32_t  maximum;
  bool      auto_extend;
  uint32_t  unallocated;
} rtems_object_api_class_information;

NOTES:

This directive is strictly local and does not impact task scheduling.

RTEMS C User's Guide