OpenBSD manual page server

Manual Page Search Parameters

GETHOSTNAME(3) Library Functions Manual GETHOSTNAME(3)

gethostname, sethostnameget/set name of current host

#include <unistd.h>

gethostname(char *name, size_t namelen);

sethostname(const char *name, size_t namelen);

The () function returns the standard host name for the current machine, as previously set by sethostname(). The parameter namelen specifies the size of the name array. If insufficient space is provided, the returned name is truncated. The returned name is always NUL terminated. If no space is provided, an error is returned.

() sets the name of the host machine to be name, which has length namelen. This call is restricted to the superuser and is normally used only when the system is bootstrapped.

If the call succeeds, a value of 0 is returned. If the call fails, a value of -1 is returned and an error code is placed in the global variable errno.

The following errors may be returned by these calls:

The name parameter gave an invalid address.
The namelen parameter was zero.
The caller tried to set the hostname and was not the superuser.

hostname(1), sysctl(2), getdomainname(3), gethostid(3), sysctl(8), yp(8)

The gethostname() function call conforms to X/Open Portability Guide Issue 4, Version 2 (“XPG4.2”).

The gethostname() function call appeared in 4.2BSD.

Host names are limited to MAXHOSTNAMELEN (from <sys/param.h>) characters, currently 256. This includes the terminating NUL character. Note that the corresponding POSIX definition HOST_NAME_MAX in <limits.h> does include the terminating NUL character.

If the buffer passed to gethostname() is smaller than MAXHOSTNAMELEN, other operating systems may not guarantee termination with NUL.

July 17, 2022 OpenBSD-7.4