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_getflags.3p (3780B)

    

  1. '\" et
  2. .TH POSIX_SPAWNATTR_GETFLAGS "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_getflags,
  12. posix_spawnattr_setflags
  13. \(em get and set the spawn-flags 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_getflags(const posix_spawnattr_t *restrict \fIattr\fP,
  21.     short *restrict \fIflags\fP);
  22. int posix_spawnattr_setflags(posix_spawnattr_t *\fIattr\fP, short \fIflags\fP);
  23. .fi
  24. .SH DESCRIPTION
  25. The
  26. \fIposix_spawnattr_getflags\fR()
  27. function shall obtain the value of the
  28. .IR spawn-flags
  29. attribute from the attributes object referenced by
  30. .IR attr .
  31. .P
  32. The
  33. \fIposix_spawnattr_setflags\fR()
  34. function shall set the
  35. .IR spawn-flags
  36. attribute in an initialized attributes object referenced by
  37. .IR attr .
  38. .P
  39. The
  40. .IR spawn-flags
  41. attribute is used to indicate which process attributes are to be
  42. changed in the new process image when invoking
  43. \fIposix_spawn\fR()
  44. or
  45. \fIposix_spawnp\fR().
  46. It is the bitwise-inclusive OR of zero or more of the following flags:
  47. .P
  48. .nf
  49. POSIX_SPAWN_RESETIDS
  50. POSIX_SPAWN_SETPGROUP
  51. POSIX_SPAWN_SETSIGDEF
  52. POSIX_SPAWN_SETSIGMASK
  53. POSIX_SPAWN_SETSCHEDPARAM
  54. POSIX_SPAWN_SETSCHEDULER
  55. .fi
  56. .P
  57. These flags are defined in
  58. .IR <spawn.h> .
  59. The default value of this attribute shall be as if no flags were set.
  60. .SH "RETURN VALUE"
  61. Upon successful completion,
  62. \fIposix_spawnattr_getflags\fR()
  63. shall return zero and store the value of the
  64. .IR spawn-flags
  65. attribute of
  66. .IR attr
  67. into the object referenced by the
  68. .IR flags
  69. parameter; otherwise, an error number shall be returned to indicate the
  70. error.
  71. .P
  72. Upon successful completion,
  73. \fIposix_spawnattr_setflags\fR()
  74. shall return zero; otherwise, an error number shall be returned to
  75. indicate the error.
  76. .SH ERRORS
  77. These functions may fail if:
  78. .TP
  79. .BR EINVAL
  80. The value specified by
  81. .IR attr
  82. is invalid.
  83. .P
  84. The
  85. \fIposix_spawnattr_setflags\fR()
  86. function may fail if:
  87. .TP
  88. .BR EINVAL
  89. The value of the attribute being set is not valid.
  90. .LP
  91. .IR "The following sections are informative."
  92. .SH EXAMPLES
  93. None.
  94. .SH "APPLICATION USAGE"
  95. These functions are part of the Spawn option and need not be
  96. provided on all implementations.
  97. .SH RATIONALE
  98. None.
  99. .SH "FUTURE DIRECTIONS"
  100. None.
  101. .SH "SEE ALSO"
  102. .ad l
  103. .IR "\fIposix_spawn\fR\^(\|)",
  104. .IR "\fIposix_spawnattr_destroy\fR\^(\|)",
  105. .IR "\fIposix_spawnattr_getsigdefault\fR\^(\|)",
  106. .IR "\fIposix_spawnattr_getpgroup\fR\^(\|)",
  107. .IR "\fIposix_spawnattr_getschedparam\fR\^(\|)",
  108. .IR "\fIposix_spawnattr_getschedpolicy\fR\^(\|)",
  109. .IR "\fIposix_spawnattr_getsigmask\fR\^(\|)"
  110. .ad b
  111. .P
  112. The Base Definitions volume of POSIX.1\(hy2017,
  113. .IR "\fB<spawn.h>\fP"
  114. .\"
  115. .SH COPYRIGHT
  116. Portions of this text are reprinted and reproduced in electronic form
  117. from IEEE Std 1003.1-2017, Standard for Information Technology
  118. -- Portable Operating System Interface (POSIX), The Open Group Base
  119. Specifications Issue 7, 2018 Edition,
  120. Copyright (C) 2018 by the Institute of
  121. Electrical and Electronics Engineers, Inc and The Open Group.
  122. In the event of any discrepancy between this version and the original IEEE and
  123. The Open Group Standard, the original IEEE and The Open Group Standard
  124. is the referee document. The original Standard can be obtained online at
  125. http://www.opengroup.org/unix/online.html .
  126. .PP
  127. Any typographical or formatting errors that appear
  128. in this page are most likely
  129. to have been introduced during the conversion of the source files to
  130. man page format. To report such errors, see
  131. https://www.kernel.org/doc/man-pages/reporting_bugs.html .