osfmk/man/DP_backing_store_delete.html

   1 <h2>default_pager_backing_store_delete</h2>
   2 <hr>
   3 <p>
   4 <strong>Server Interface</strong> - Delete 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_delete</strong>
  10                 <strong>(mach_port_t</strong>                      <var>backing_store</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>backing_store</var>
  16 <dd>
  17 [in backing store (receive) right] The backing store port created by
  18 default_pager_backing_store_create.
  19 </dl>
  20 <h3>DESCRIPTION</h3>
  21 <p>
  22 The <strong>default_pager_backing_store_delete</strong> function is called to destroy a
  23 backing storage object created by
  24 <strong>default_pager_backing_store_create</strong>. The kernel does not make this call
  25 itself (which is why it can be a synchronous call); this request is
  26 only issued by tasks holding the backing store port, created with
  27 <strong>default_pager_backing_store_create</strong>, for a default memory manager.
  28 <h3>RETURN VALUES</h3>
  29 <dl>
  30 <p>
  31 <dt> <strong>KERN_FAILURE</strong>
  32 <dd>
  33 The default pager does not support this operation.
  34 <p>
  35 <dt> <strong>KERN_INVALID_ARGUMENT</strong>
  36 <dd>
  37 The backing_store port does not represent a valid backing store or the
  38 specified segment overlaps an existing partition.
  39 <p>
  40 <dt> <strong>KERN_SUCCESS</strong>
  41 <dd>
  42 The operation was successful.
  43 </dl>
  44 <h3>RELATED INFORMATION</h3>
  45 <p>
  46 Functions:
  47 <a href="DP_backing_store_create.html"><strong>default_pager_backing_store_create</strong></a>,
  48 <a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.