man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

gethostname(3C)

Name

gethostname, sethostname - get or set name of current host

Synopsis

#include <unistd.h>

int gethostname(char *
name, size_t namelen);
int sethostname(
char *name, size_t 
namelen);

Description

The gethostname() function returns the standard host name for the current processor, as previously set by sethostname (). The namelen argument specifies the size of the array pointed to by name. The returned name is null-terminated unless insufficient space is provided.

The sethostname() function 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.

Host names are limited to MAXHOSTNAMELEN characters, currently 256, defined in the <netdb.h> header.

Return Values

Upon successful completion, gethostname() and sethostname() return 0. Otherwise, they return −1 and set errno to indicate the error.

Errors

The gethostname() and sethostname() functions will fail if:

EFAULT

The name argument is an invalid address.

The sethostname() function will fail if:

EPERM

The {PRIV_SYS_ADMIN} privilege was not asserted in the effective set of the calling process.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

sysinfo(2) , uname(2) , gethostid(3C), attributes(5) , standards (5)