xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / DP_backing_store_delete.html

<h2>default_pager_backing_store_delete</h2>
<hr>
<p>
<strong>Server Interface</strong> - Delete a backing storage object.
<h3>SYNOPSIS</h3>
<pre>
<strong>#include&lt mach/default_pager_object.h&gt</strong>

<strong>kern_return_t   default_pager_backing_store_delete</strong>
                <strong>(mach_port_t</strong>                      <var>backing_store</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>backing_store</var>
<dd>
[in backing store (receive) right] The backing store port created by 
default_pager_backing_store_create.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>default_pager_backing_store_delete</strong> function is called to destroy a
backing storage object created by
<strong>default_pager_backing_store_create</strong>. The kernel does not make this call
itself (which is why it can be a synchronous call); this request is
only issued by tasks holding the backing store port, created with
<strong>default_pager_backing_store_create</strong>, for a default memory manager.
<h3>RETURN VALUES</h3>
<dl>
<p>
<dt> <strong>KERN_FAILURE</strong>
<dd>
The default pager does not support this operation.
<p>
<dt> <strong>KERN_INVALID_ARGUMENT</strong>
<dd>
The backing_store port does not represent a valid backing store or the 
specified segment overlaps an existing partition.
<p>
<dt> <strong>KERN_SUCCESS</strong>
<dd>
The operation was successful.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="DP_backing_store_create.html"><strong>default_pager_backing_store_create</strong></a>,
<a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.