summaryrefslogtreecommitdiffstats
path: root/doc/antora/modules/unlang/pages/return_codes.adoc
blob: 3b09c2dc525ccc722c08aaaafb66bcd5d702e45e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
= Return codes

Many operations in the server produce a return code (rcode).
The different rcodes give a course indication of whether a particular operation
(a module call, string expansion, or keyword) was successful.

Unlike return values in other languages, FreeRADIUS' rcodes are are always taken
from a fixed compiled-in set.

include::partial$rcode_table.adoc[]

Return codes propagate through nested unlang sections based on their priority.
If a rcode returned by an operation has a higher priority than the current rcode
associated with the request, then the request rcode is overwritten.

Return code priorities are assigned by the section the module call, expansion or
keyword was used in.