osfmk/man/host_processor_sets.html

   1 <h2>host_processor_sets</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return a list of send rights representing all processor set name ports.
   5
   6 <h3>SYNOPSIS</h3>
   7 <pre>
   8 <strong>kern_return_t   host_processor_sets</strong>
   9                 <strong>(host_priv_t</strong>                          <var>host_priv</var>,
  10                  <strong>processor_set_name_port_array_t</strong><var>processor_set_name_list</var>,
  11                  <strong>host_priv</strong>             <var>processor_set_name_count</var><strong>);</strong>
  12 </pre>
  13 <h3>PARAMETERS</h3>
  14 <dl>
  15 <p>
  16 <dt> <var>host_priv</var>
  17 <dd>
  18 [in host-control send right]
  19 The control port for the host for which the
  20 processor sets are desired.
  21 <p>
  22 <dt> <var>processor_set_name_list</var>
  23 <dd>
  24 [out pointer to dynamic array of processor-set-name send rights]
  25 The
  26 set of processor set name ports for those currently existing on
  27 <var>host_priv</var>; no particular order is guaranteed.
  28 <p>
  29 <dt> <var>processor_set_name_count</var>
  30 <dd>
  31 [out scalar]
  32 The number of processor set names returned.
  33 </dl>
  34 <h3>DESCRIPTION</h3>
  35 <p>
  36 The <strong>host_processor_sets</strong> function returns send rights
  37 for the name ports for
  38 each processor set currently existing on host.
  39 <h3>NOTES</h3>
  40 <p>
  41 If control ports to the processor sets are needed, use
  42 <strong>host_processor_set_priv</strong>.
  43 <h3>RETURN VALUES</h3>
  44 <p>
  45 Only generic errors apply.
  46 <h3>RELATED INFORMATION</h3>
  47 <p>
  48 Functions:
  49 <a href="host_processor_set_priv.html"><strong>host_processor_set_priv</strong></a>,
  50 <a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
  51 <a href="processor_set_tasks.html"><strong>processor_set_tasks</strong></a>,
  52 <a href="processor_set_threads.html"><strong>processor_set_threads</strong></a>.