Page MenuHomeFreeBSD
Files F148631974

D55336.id172099.diff
No OneTemporary
Actions

D55336.id172099.diff
View Options

diff --git a/lib/libc/gen/Makefile.inc b/lib/libc/gen/Makefile.inc
--- a/lib/libc/gen/Makefile.inc
+++ b/lib/libc/gen/Makefile.inc
@@ -323,6 +323,7 @@
ttyname.3 \
ualarm.3 \
ucontext.3 \
+ uexterr_gettext.3 \
ulimit.3 \
uname.3 \
unvis.3 \
diff --git a/lib/libc/gen/uexterr_gettext.3 b/lib/libc/gen/uexterr_gettext.3
new file mode 100644
--- /dev/null
+++ b/lib/libc/gen/uexterr_gettext.3
@@ -0,0 +1,71 @@
+.\" Copyright 2026 The FreeBSD Foundation
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.\" This documentation was written by
+.\" Konstantin Belousov <kib@FreeBSD.org> under sponsorship
+.\" from the FreeBSD Foundation.
+.\"
+.Dd Feburary 17, 2026
+.Dt UEXTERR_GETTEXT
+.Os
+.Sh NAME
+.Nm uexterr_gettext
+.Nd "get string representation of the current extended error"
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In exterr.h
+.Ft int
+.Fo uexterr_gettext
+.Fa "char *buffer"
+.Fa "size_t buffer_size"
+.Fc
+.Sh DESCRIPTION
+The
+.Nm
+function fills the buffer pointed to by the
+.Fa buffer
+pointer with the formatted extended null-terminated
+error string, as reported by the
+last error from a system call, which returned extended error.
+The capacity of the passed buffer is
+.Va buffer_size
+bytes.
+.Pp
+Normally, applications should use
+.Xr err 3
+family of functions to display errors from system calls.
+If this is not convenient or even not possible,
+for instance for applications with advanced user interface, the
+.Nm
+function can be used to fetch the string with extended error.
+.Pp
+Note that most parts of the extended errors are directly provided by
+kernel, and as such cannot be localized.
+.Pp
+See
+.Xr exterror 9
+for the description of the extended error facilities.
+.Sh RETURN VALUES
+The
+.Fn
+functions return zero.
+There is currently no errors defined for the function,
+which might change in future.
+.Pp
+If any error condition would be added, it will be reported by returning \-1
+and setting
+.Va errno
+to the corresponding value.
+.Sh SEE ALSO
+.Xr errno 3 ,
+.Xr err 3 ,
+.Xr exterror 9
+.Sh STANDARDS
+The
+.Nm
+is
+.Fx
+extension that first appeared in
+.Fx 15.0 .
diff --git a/share/man/man9/exterror.9 b/share/man/man9/exterror.9
--- a/share/man/man9/exterror.9
+++ b/share/man/man9/exterror.9
@@ -221,7 +221,8 @@
from the failed request back to the thread that create the request.
.Sh SEE ALSO
.Xr errno 3 ,
-.Xr err 3
+.Xr err 3 ,
+.Xr uexterr_gettext 3
.Sh HISTORY
The
.Nm

File Metadata

Mime Type
text/plain
Expires
Fri, Mar 20, 6:27 AM (7 h, 57 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
30004199
Default Alt Text
D55336.id172099.diff (2 KB)

Event Timeline