object_services.rst: Add _rtems_object_id_api_minimum_class and _rtems_object_id_api_maximum_class

This commit is contained in:
Joel Sherrill 2016-10-28 11:42:35 -05:00
parent 4e71fe2687
commit 154f3dc68b
2 changed files with 67 additions and 1 deletions

View File

@ -601,6 +601,70 @@ for the specified ``api``.
This directive is strictly local and does not impact task scheduling. This directive is strictly local and does not impact task scheduling.
.. _rtems_object_id_api_minimum_class:
OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API
-------------------------------------------------------------------
.. index:: obtain minimum class value for an API
**CALLING SEQUENCE:**
.. index:: rtems_object_id_api_minimum_class
.. code-block:: c
int rtems_object_get_id_api_minimum_class(
int api
);
**DIRECTIVE STATUS CODES**
If ``api`` is not valid, -1 is returned.
If successful, this service returns the index corresponding to the first
object class of the specified ``api``.
**DESCRIPTION:**
This service returns the index for the first object class associated with
the specified ``api``.
**NOTES:**
This directive is strictly local and does not impact task scheduling.
.. _rtems_object_id_api_maximum_class:
OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API
-------------------------------------------------------------------
.. index:: obtain maximum class value for an API
**CALLING SEQUENCE:**
.. index:: rtems_object_id_api_maximum_class
.. code-block:: c
int rtems_object_get_api_maximum_class(
int api
);
**DIRECTIVE STATUS CODES**
If ``api`` is not valid, -1 is returned.
If successful, this service returns the index corresponding to the last
object class of the specified ``api``.
**DESCRIPTION:**
This service returns the index for the last object class associated with
the specified ``api``.
**NOTES:**
This directive is strictly local and does not impact task scheduling.
.. _rtems_object_get_api_name: .. _rtems_object_get_api_name:
OBJECT_GET_API_NAME - Obtain API Name OBJECT_GET_API_NAME - Obtain API Name
@ -671,6 +735,8 @@ This directive is strictly local and does not impact task scheduling.
The string returned is from constant space. Do not modify or free it. The string returned is from constant space. Do not modify or free it.
.. _rtems_object_get_class_information:
OBJECT_GET_CLASS_INFORMATION - Obtain Class Information OBJECT_GET_CLASS_INFORMATION - Obtain Class Information
------------------------------------------------------- -------------------------------------------------------
.. index:: obtain class information .. index:: obtain class information

View File

@ -865,7 +865,7 @@ RATE_MONOTONIC_GET_STATUS - Obtain status from a period
rtems_status_code rtems_rate_monotonic_get_status( rtems_status_code rtems_rate_monotonic_get_status(
rtems_id id, rtems_id id,
rtems_rate_monotonic_period_status \status rtems_rate_monotonic_period_status *status
); );
**DIRECTIVE STATUS CODES:** **DIRECTIVE STATUS CODES:**