The Open Group Base Specifications Issue 8
IEEE Std 1003.1-2024
Copyright © 2001-2024 The IEEE and The Open Group

NAME

grantpt — grant access to the subsidiary pseudo-terminal device

SYNOPSIS

[XSI] [Option Start] #include <stdlib.h>

int grantpt(int
fildes); [Option End]

DESCRIPTION

The grantpt() function shall change the mode and ownership of the subsidiary pseudo-terminal device associated with its manager pseudo-terminal counterpart. The fildes argument is a file descriptor that refers to a manager pseudo-terminal device. The user ID of the subsidiary shall be set to the real UID of the calling process and the group ID shall be set to an unspecified group ID. The permission mode of the subsidiary pseudo-terminal shall be set to readable and writable by the owner, and writable by the group.

The behavior of the grantpt() function is unspecified if the application has installed a signal handler to catch SIGCHLD signals.

RETURN VALUE

Upon successful completion, grantpt() shall return 0; otherwise, it shall return -1 and set errno to indicate the error.

ERRORS

The grantpt() function may fail if:

[EACCES]
The corresponding subsidiary pseudo-terminal device could not be accessed.
[EBADF]
The fildes argument is not a valid open file descriptor.
[EINVAL]
The fildes argument is not associated with a manager pseudo-terminal device.

The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

See the RATIONALE section for posix_openpt .

FUTURE DIRECTIONS

None.

SEE ALSO

open , posix_openpt , ptsname , unlockpt

XBD <stdlib.h>

CHANGE HISTORY

First released in Issue 4, Version 2.

Issue 5

Moved from X/OPEN UNIX extension to BASE.

The last paragraph of the DESCRIPTION is moved from the APPLICATION USAGE section.

Issue 7

POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0272 [96] is applied.

POSIX.1-2008, Technical Corrigendum 2, XSH/TC2-2008/0177 [506] is applied.

Issue 8

Austin Group Defect 1466 is applied, changing the terminology used for pseudo-terminal devices.

End of informative text.

 

return to top of page

UNIX® is a registered Trademark of The Open Group.
POSIX™ is a Trademark of The IEEE.
Copyright © 2001-2024 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]