summaryrefslogtreecommitdiffstats
path: root/spec/rtems/intr/if/server-delete.yml
blob: ec64c6ee729a45fda3d102142d8f4ce939b119e9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Deletes the interrupt server.
copyrights:
- Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG
definition:
  default:
    attributes: null
    body: null
    params:
    - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-task
- role: constraint
  uid: ../constraint/not-within-server
- role: constraint
  uid: /constraint/request-response
name: rtems_interrupt_server_delete
notes: |
  The interrupt server deletes itself, so after the return of the directive the
  interrupt server may be still in the termination process depending on the
  task priorities of the system.

  See also ${server-create:/name}.
params:
- description: |
    is the index of the interrupt server to delete.
  dir: null
  name: server_index
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      There was no interrupt server associated with the server index specified
      by ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
type: interface