logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

posix_spawnattr_getpgroup.3p (3520B)

    

  1. '\" et
  2. .TH POSIX_SPAWNATTR_GETPGROUP "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. posix_spawnattr_getpgroup,
  12. posix_spawnattr_setpgroup
  13. \(em get and set the spawn-pgroup attribute of a spawn attributes object
  14. (\fBADVANCED REALTIME\fP)
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <spawn.h>
  19. .P
  20. int posix_spawnattr_getpgroup(const posix_spawnattr_t *restrict \fIattr\fP,
  21.     pid_t *restrict \fIpgroup\fP);
  22. int posix_spawnattr_setpgroup(posix_spawnattr_t *\fIattr\fP, pid_t \fIpgroup\fP);
  23. .fi
  24. .SH DESCRIPTION
  25. The
  26. \fIposix_spawnattr_getpgroup\fR()
  27. function shall obtain the value of the
  28. .IR spawn-pgroup
  29. attribute from the attributes object referenced by
  30. .IR attr .
  31. .P
  32. The
  33. \fIposix_spawnattr_setpgroup\fR()
  34. function shall set the
  35. .IR spawn-pgroup
  36. attribute in an initialized attributes object referenced by
  37. .IR attr .
  38. .P
  39. The
  40. .IR spawn-pgroup
  41. attribute represents the process group to be joined by the new process
  42. image in a spawn operation (if POSIX_SPAWN_SETPGROUP is set in the
  43. .IR spawn-flags
  44. attribute). The default value of this attribute shall be zero.
  45. .SH "RETURN VALUE"
  46. Upon successful completion,
  47. \fIposix_spawnattr_getpgroup\fR()
  48. shall return zero and store the value of the
  49. .IR spawn-pgroup
  50. attribute of
  51. .IR attr
  52. into the object referenced by the
  53. .IR pgroup
  54. parameter; otherwise, an error number shall be returned to indicate the
  55. error.
  56. .P
  57. Upon successful completion,
  58. \fIposix_spawnattr_setpgroup\fR()
  59. shall return zero; otherwise, an error number shall be returned to
  60. indicate the error.
  61. .SH ERRORS
  62. These functions may fail if:
  63. .TP
  64. .BR EINVAL
  65. The value specified by
  66. .IR attr
  67. is invalid.
  68. .P
  69. The
  70. \fIposix_spawnattr_setpgroup\fR()
  71. function may fail if:
  72. .TP
  73. .BR EINVAL
  74. The value of the attribute being set is not valid.
  75. .LP
  76. .IR "The following sections are informative."
  77. .SH EXAMPLES
  78. None.
  79. .SH "APPLICATION USAGE"
  80. These functions are part of the Spawn option and need not be
  81. provided on all implementations.
  82. .SH RATIONALE
  83. None.
  84. .SH "FUTURE DIRECTIONS"
  85. None.
  86. .SH "SEE ALSO"
  87. .ad l
  88. .IR "\fIposix_spawn\fR\^(\|)",
  89. .IR "\fIposix_spawnattr_destroy\fR\^(\|)",
  90. .IR "\fIposix_spawnattr_getsigdefault\fR\^(\|)",
  91. .IR "\fIposix_spawnattr_getflags\fR\^(\|)",
  92. .IR "\fIposix_spawnattr_getschedparam\fR\^(\|)",
  93. .IR "\fIposix_spawnattr_getschedpolicy\fR\^(\|)",
  94. .IR "\fIposix_spawnattr_getsigmask\fR\^(\|)"
  95. .ad b
  96. .P
  97. The Base Definitions volume of POSIX.1\(hy2017,
  98. .IR "\fB<spawn.h>\fP"
  99. .\"
  100. .SH COPYRIGHT
  101. Portions of this text are reprinted and reproduced in electronic form
  102. from IEEE Std 1003.1-2017, Standard for Information Technology
  103. -- Portable Operating System Interface (POSIX), The Open Group Base
  104. Specifications Issue 7, 2018 Edition,
  105. Copyright (C) 2018 by the Institute of
  106. Electrical and Electronics Engineers, Inc and The Open Group.
  107. In the event of any discrepancy between this version and the original IEEE and
  108. The Open Group Standard, the original IEEE and The Open Group Standard
  109. is the referee document. The original Standard can be obtained online at
  110. http://www.opengroup.org/unix/online.html .
  111. .PP
  112. Any typographical or formatting errors that appear
  113. in this page are most likely
  114. to have been introduced during the conversion of the source files to
  115. man page format. To report such errors, see
  116. https://www.kernel.org/doc/man-pages/reporting_bugs.html .