source: rtems/cpukit/rtems/src/regiongetinfo.c @ 6b5f22dc

Last change on this file since 6b5f22dc was 6b5f22dc, checked in by Sebastian Huber <sebastian.huber@…>, on 11/26/20 at 10:45:47

rtems: Canonicalize Doxygen @file comments

Use common phrases for the file brief descriptions.

Update #3706.

  • Property mode set to 100644
File size: 935 bytes
Line 
1/**
2 * @file
3 *
4 * @ingroup RTEMSImplClassicRegion
5 *
6 * @brief This source file contains the implementation of
7 *   rtems_region_get_information().
8 */
9
10/*
11 *  COPYRIGHT (c) 1989-2014.
12 *  On-Line Applications Research Corporation (OAR).
13 *
14 *  The license and distribution terms for this file may be
15 *  found in the file LICENSE in this distribution or at
16 *  http://www.rtems.org/license/LICENSE.
17 */
18
19#ifdef HAVE_CONFIG_H
20#include "config.h"
21#endif
22
23#include <rtems/rtems/regionimpl.h>
24
25rtems_status_code rtems_region_get_information(
26  rtems_id                id,
27  Heap_Information_block *the_info
28)
29{
30  Region_Control *the_region;
31
32  if ( the_info == NULL ) {
33    return RTEMS_INVALID_ADDRESS;
34  }
35
36  the_region = _Region_Get_and_lock( id );
37
38  if ( the_region == NULL ) {
39    return RTEMS_INVALID_ID;
40  }
41
42  _Heap_Get_information( &the_region->Memory, the_info );
43
44  _Region_Unlock( the_region );
45  return RTEMS_SUCCESSFUL;
46}
Note: See TracBrowser for help on using the repository browser.