osfmk/man/mach_port_set_mscount.html

   1 <h2>mach_port_set_mscount</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Change the target port's make-send count.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   mach_port_set_mscount</strong>
   8                 <strong>(ipc_space_t</strong>                               <var>task</var>,
   9                  <strong>mach_port_name_t</strong>                          <var>name</var>,
  10                  <strong>mach_port_mscount_t</strong>                    <var>mscount</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>task</var>
  16 <dd>
  17 [in task send right]
  18 The task owning the receive right.
  19 <p>
  20 <dt> <var>name</var>
  21 <dd>
  22 [in scalar]
  23 <var>task</var>'s name for the receive right.
  24 <p>
  25 <dt> <var>mscount</var>
  26 <dd>
  27 [in scalar]
  28 New value for the make-send count for the receive right.
  29 </dl>
  30 <h3>DESCRIPTION</h3>
  31 <p>
  32 The <strong>mach_port_set_mscount</strong> function changes the make-send
  33 count of <var>task</var>'s
  34 receive right named <var>name</var>.
  35 A port's make-send count specifies the number of send rights that have
  36 been generated via the port's receive right.  A port's make-send count
  37 is set to zero when the port is first allocated; the count is reset to
  38 zero each time the port's receive right is transferred via a Mach message.
  39 <h3>NOTES</h3>
  40 <p>
  41 This interface is machine word length specific because of the port name
  42 parameter.
  43 <h3>RETURN VALUES</h3>
  44 <dl>
  45 <p>
  46 <dt> <strong>KERN_INVALID_NAME</strong>
  47 <dd>
  48 <var>name</var> did not denote a right.
  49 <p>
  50 <dt> <strong>KERN_INVALID_RIGHT</strong>
  51 <dd>
  52 <var>name</var> denoted a right, but not a receive right.
  53 </dl>
  54 <h3>RELATED INFORMATION</h3>
  55 <p>
  56 Functions:
  57 <a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.