gethostname
Prev  Section 2  Next

Name

gethostname, sethostname — get/set host name

Synopsis

#include <unistd.h>
int gethostname( char *  name,
  size_t   len);
int sethostname( const char *  name,
  size_t   len);
[Note] Note
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
gethostname():
_BSD_SOURCE || _XOPEN_SOURCE >= 500
sethostname():
_BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)

DESCRIPTION

These system calls are used to access or to change the host name of the current processor. The gethostname() system call returns a null-terminated hostname (set earlier by sethostname()) in the array name that has a length of len bytes. In case the null-terminated hostname does not fit, no error is returned, but the hostname is truncated. It is unspecified whether the truncated hostname will be null-terminated.

RETURN VALUE

On success, zero is returned. On error, −1 is returned, and errno is set appropriately.

ERRORS

EFAULT

name is an invalid address.

EINVAL

len is negative or, for sethostname(), len is larger than the maximum allowed size, or, for gethostname() on Linux/i386, len is smaller than the actual size. (In this last case glibc 2.1 uses ENAMETOOLONG.)

EPERM

For sethostname(), the caller did not have the CAP_SYS_ADMIN capability.

CONFORMING TO

SVr4, 4.4BSD (these interfaces first appeared in 4.2BSD). POSIX.1-2001 specifies gethostname() but not sethostname().

NOTES

SUSv2 guarantees that "Host names are limited to 255 bytes". POSIX.1-2001 guarantees that "Host names (not including the terminating null byte) are limited to HOST_NAME_MAX bytes".

Glibc Notes

The GNU C library implements gethostname() as a library function that calls uname(2) and copies up to len bytes from the returned nodename field into name. Having performed the copy, the function then checks if the length of the nodename was greater than or equal to len, and if it is, then the function returns −1 with errno set to ENAMETOOLONG. Versions of glibc before 2.2 handle the case where the length of the nodename was greater than or equal to len differently: nothing is copied into name and the function returns −1 with errno set to ENAMETOOLONG.

SEE ALSO

getdomainname(2), setdomainname(2), uname(2)

COLOPHON

This page is part of release 2.79 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.


Copyright 1993 Rickard E. Faith (faithcs.unc.edu)

Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Since the Linux kernel and libraries are constantly changing, this
manual page may be incorrect or out-of-date.  The author(s) assume no
responsibility for errors or omissions, or for damages resulting from
the use of the information contained herein.  The author(s) may not
have taken the same level of care in the production of this manual,
which is licensed free of charge, as they might when working
professionally.

Formatted or processed versions of this manual, if unaccompanied by
the source, must acknowledge the copyright and authors of this work.

Modified 1995-07-22 by Michael Chastain <mecduracef.shout.net>:
  'gethostname' is real system call on Linux/Alpha.
Modified 1997-01-31 by Eric S. Raymond <esrthyrsus.com>
Modified 2000-06-04, 2001-12-15 by aeb
Modified 2004-06-17 by mtk
Prev  Up  Next
gethostid  Home  getitimer