diff options
Diffstat (limited to 'cpukit/include/rtems/extension.h')
-rw-r--r-- | cpukit/include/rtems/extension.h | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/cpukit/include/rtems/extension.h b/cpukit/include/rtems/extension.h index 870fa5b215..44264c4176 100644 --- a/cpukit/include/rtems/extension.h +++ b/cpukit/include/rtems/extension.h @@ -122,11 +122,34 @@ typedef Internal_errors_Source rtems_fatal_source; /** * @ingroup RTEMSAPIClassicUserext * - * @brief % + * @brief Identifies an extension set object by the specified object name. * - * @param name % + * This directive obtains the extension set identifier associated with the + * extension set name specified in ``name``. * - * @param id % + * If the extension set name is not unique, then the extension set identifier + * will match the first extension set with that name in the search order. + * However, this extension set identifier is not guaranteed to correspond to + * the desired extension set. The extension set identifier is used with other + * extension related directives to access the extension set. + * + * The objects are searched from lowest to the highest index. Only the local + * node is searched. + * + * @param name is the object name to look up. + * + * @param[out] id is the pointer to an object identifier variable. The object + * identifier of an object with the specified name will be stored in this + * variable, in case of a successful operation. + * + * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. + * + * @retval ::RTEMS_INVALID_ADDRESS The id parameter was NULL. + * + * @retval ::RTEMS_INVALID_NAME The name parameter was 0. + * + * @retval ::RTEMS_INVALID_NAME There was no object with the specified name on + * the local node. */ rtems_status_code rtems_extension_ident( rtems_name name, rtems_id *id ); |