Index for Section 3

Alphabetical listing for S

Bottom of page

sched_getparam(3)
NAME
  sched_getparam - Returns the scheduling parameters of the specified process
  (P1003.1b)

LIBRARY
  Realtime Library (librt.so, librt.a)

SYNOPSIS
  #include <sched.h>

  int sched_getparam (
  pid_t pid,
  struct sched_param *param);

PARAMETERS
  pid	  Specifies the ID of the process for which scheduling parameters are
	  to be returned. If pid is zero, the scheduling parameters of the
	  calling process are returned.

  *param  Specifies a pointer to a sched_param structure to receive the
	  scheduling parameters of the specified process. The priority field
	  receives the current priority of the process specified by the pid.
	  The sched_param structure is defined in <sched.h>.

DESCRIPTION
  The sched_getparam function returns the scheduling parameters of a process.
  If the pid is zero, the scheduling parameters are returned for the calling
  process.

  Use the sched_setparam function to change the scheduling parameters.

  Currently, the sched_param structure contains only a priority field.

  The priority of a process is inherited across fork and exec calls.

  No special privileges are needed to use the sched_getparam function.

RETURN VALUES
  On a successful call to the sched_getparam function, a value of 0 (zero) is
  returned. On an unsuccessful call, a value of -1 is returned and errno is
  set to indicate that an error occurred and that no scheduling parameters
  were returned.

ERRORS
  The sched_getparam function fails under the following conditions:

  [EINVAL]	 Invalid value specified for the pid argument, the param
		 pointer is NULL, or one or more of the parameters in it is
		 outside the valid range.

  [ESRCH]	 No process can be found corresponding to that specified by
		 pid.

RELATED INFORMATION
  Functions: getpid(2), sched_getscheduler(3), sched_setparam(3),
  sched_setscheduler(3)

  Guide to Realtime Programming

Index for Section 3

Alphabetical listing for S

Top of page