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

sched_getparam.3p (2835B)

    

  1. '\" et
  2. .TH SCHED_GETPARAM "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. sched_getparam
  12. \(em get scheduling parameters
  13. (\fBREALTIME\fP)
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <sched.h>
  18. .P
  19. int sched_getparam(pid_t \fIpid\fP, struct sched_param *\fIparam\fP);
  20. .fi
  21. .SH DESCRIPTION
  22. The
  23. \fIsched_getparam\fR()
  24. function shall return the scheduling parameters of a process specified by
  25. .IR pid
  26. in the
  27. .BR sched_param
  28. structure pointed to by
  29. .IR param .
  30. .P
  31. If a process specified by
  32. .IR pid
  33. exists, and if the calling process has permission, the scheduling
  34. parameters for the process whose process ID is equal to
  35. .IR pid
  36. shall be returned.
  37. .P
  38. If
  39. .IR pid
  40. is zero, the scheduling parameters for the calling process shall be
  41. returned. The behavior of the
  42. \fIsched_getparam\fR()
  43. function is unspecified if the value of
  44. .IR pid
  45. is negative.
  46. .SH "RETURN VALUE"
  47. Upon successful completion, the
  48. \fIsched_getparam\fR()
  49. function shall return zero. If the call to
  50. \fIsched_getparam\fR()
  51. is unsuccessful, the function shall return a value of \-1 and set
  52. .IR errno
  53. to indicate the error.
  54. .SH ERRORS
  55. The
  56. \fIsched_getparam\fR()
  57. function shall fail if:
  58. .TP
  59. .BR EPERM
  60. The requesting process does not have permission to obtain the
  61. scheduling parameters of the specified process.
  62. .TP
  63. .BR ESRCH
  64. No process can be found corresponding to that specified by
  65. .IR pid .
  66. .LP
  67. .IR "The following sections are informative."
  68. .SH EXAMPLES
  69. None.
  70. .SH "APPLICATION USAGE"
  71. None.
  72. .SH RATIONALE
  73. None.
  74. .SH "FUTURE DIRECTIONS"
  75. None.
  76. .SH "SEE ALSO"
  77. .IR "\fIsched_getscheduler\fR\^(\|)",
  78. .IR "\fIsched_setparam\fR\^(\|)",
  79. .IR "\fIsched_setscheduler\fR\^(\|)"
  80. .P
  81. The Base Definitions volume of POSIX.1\(hy2017,
  82. .IR "\fB<sched.h>\fP"
  83. .\"
  84. .SH COPYRIGHT
  85. Portions of this text are reprinted and reproduced in electronic form
  86. from IEEE Std 1003.1-2017, Standard for Information Technology
  87. -- Portable Operating System Interface (POSIX), The Open Group Base
  88. Specifications Issue 7, 2018 Edition,
  89. Copyright (C) 2018 by the Institute of
  90. Electrical and Electronics Engineers, Inc and The Open Group.
  91. In the event of any discrepancy between this version and the original IEEE and
  92. The Open Group Standard, the original IEEE and The Open Group Standard
  93. is the referee document. The original Standard can be obtained online at
  94. http://www.opengroup.org/unix/online.html .
  95. .PP
  96. Any typographical or formatting errors that appear
  97. in this page are most likely
  98. to have been introduced during the conversion of the source files to
  99. man page format. To report such errors, see
  100. https://www.kernel.org/doc/man-pages/reporting_bugs.html .