gethostname.3p (2300B)
- '\" et
- .TH GETHOSTNAME "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
- .\"
- .SH PROLOG
- This manual page is part of the POSIX Programmer's Manual.
- The Linux implementation of this interface may differ (consult
- the corresponding Linux manual page for details of Linux behavior),
- or the interface may not be implemented on Linux.
- .\"
- .SH NAME
- gethostname
- \(em get name of current host
- .SH SYNOPSIS
- .LP
- .nf
- #include <unistd.h>
- .P
- int gethostname(char *\fIname\fP, size_t \fInamelen\fP);
- .fi
- .SH DESCRIPTION
- The
- \fIgethostname\fR()
- function shall return the standard host name for the current machine.
- The
- .IR namelen
- argument shall specify the size of the array pointed to by the
- .IR name
- argument. The returned name shall be null-terminated, except that if
- .IR namelen
- is an insufficient length to hold the host name, then the returned name
- shall be truncated and it is unspecified whether the returned name is
- null-terminated.
- .P
- Host names are limited to
- {HOST_NAME_MAX}
- bytes.
- .SH "RETURN VALUE"
- Upon successful completion, 0 shall be returned; otherwise, \-1 shall
- be returned.
- .SH ERRORS
- No errors are defined.
- .LP
- .IR "The following sections are informative."
- .SH "EXAMPLES"
- None.
- .SH "APPLICATION USAGE"
- None.
- .SH "RATIONALE"
- None.
- .SH "FUTURE DIRECTIONS"
- None.
- .SH "SEE ALSO"
- .IR "\fIgethostid\fR\^(\|)",
- .IR "\fIuname\fR\^(\|)"
- .P
- The Base Definitions volume of POSIX.1\(hy2017,
- .IR "\fB<unistd.h>\fP"
- .\"
- .SH COPYRIGHT
- Portions of this text are reprinted and reproduced in electronic form
- from IEEE Std 1003.1-2017, Standard for Information Technology
- -- Portable Operating System Interface (POSIX), The Open Group Base
- Specifications Issue 7, 2018 Edition,
- Copyright (C) 2018 by the Institute of
- Electrical and Electronics Engineers, Inc and The Open Group.
- In the event of any discrepancy between this version and the original IEEE and
- The Open Group Standard, the original IEEE and The Open Group Standard
- is the referee document. The original Standard can be obtained online at
- http://www.opengroup.org/unix/online.html .
- .PP
- Any typographical or formatting errors that appear
- in this page are most likely
- to have been introduced during the conversion of the source files to
- man page format. To report such errors, see
- https://www.kernel.org/doc/man-pages/reporting_bugs.html .