osfmk/man/DP_backing_store_create.html

   1 <h2>default_pager_backing_store_create</h2>
   2 <hr>
   3 <p>
   4 <strong>Server Interface</strong> - Create a backing storage object.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>#include&lt mach/default_pager_object.h&gt</strong>
   8
   9 <strong>kern_return_t   default_pager_backing_store_create</strong>
  10                 <strong>(mach_port_t</strong>                              <var>pager</var>,
  11                  <strong>int</strong>                                   <var>priority</var>,
  12                  <strong>int</strong>                                     <var>clsize</var>,
  13                  <strong>mach_port_t</strong>                      <var>backing_store</var><strong>);</strong>
  14 </pre>
  15 <h3>PARAMETERS</h3>
  16 <dl>
  17 <p>
  18 <dt> <var>pager</var>
  19 <dd>
  20 [in default pager (receive) right] The default pager service port.
  21 <p>
  22 <dt> <var>priority</var>
  23 <dd>
  24 [in scalar] The scheduling priority for the backing store service
  25 thread(s).
  26 <p>
  27 <dt> <var>clsize</var>
  28 <dd>
  29 [in scalar] The preferred cluster size (in bytes) for the backing
  30 store object.
  31 <p>
  32 <dt> <var>backing_store</var>
  33 <dd>
  34 [out backing store (receive) right] The port used to manipulate the
  35 created backing store.
  36 </dl>
  37 <h3>DESCRIPTION</h3>
  38 <p>
  39 The <strong>default_pager_backing_store_create</strong> function is called to create a
  40 new backing storage object. The kernel does not make this call itself
  41 (which is why it can be a synchronous call); this request is only
  42 issued by tasks (privileged) holding the default pager service port.
  43 <h3>RETURN VALUES</h3>
  44 <dl>
  45 <p>
  46 <dt> <strong>KERN_FAILURE</strong>
  47 <dd>
  48 The default pager does not support this operation.
  49 <p>
  50 <dt> <strong>KERN_INVALID_ARGUMENT</strong>
  51 <dd>
  52 The pager port does not represent a valid default pager.
  53 <p>
  54 <dt> <strong>KERN_SUCCESS</strong>
  55 <dd>
  56 The operation was successful.
  57 </dl>
  58 <h3>RELATED INFORMATION</h3>
  59 <p>
  60 Functions:
  61 <a href="DP_backing_store_delete.html"><strong>default_pager_backing_store_delete</strong></a>,
  62 <a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.