xref: /xnu-10002.1.13/osfmk/man/DP_backing_store_delete.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>default_pager_backing_store_delete</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Server Interface</strong> - Delete a backing storage object.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>#include&lt mach/default_pager_object.h&gt</strong>
8*1031c584SApple OSS Distributions
9*1031c584SApple OSS Distributions<strong>kern_return_t   default_pager_backing_store_delete</strong>
10*1031c584SApple OSS Distributions                <strong>(mach_port_t</strong>                      <var>backing_store</var><strong>);</strong>
11*1031c584SApple OSS Distributions</pre>
12*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
13*1031c584SApple OSS Distributions<dl>
14*1031c584SApple OSS Distributions<p>
15*1031c584SApple OSS Distributions<dt> <var>backing_store</var>
16*1031c584SApple OSS Distributions<dd>
17*1031c584SApple OSS Distributions[in backing store (receive) right] The backing store port created by
18*1031c584SApple OSS Distributionsdefault_pager_backing_store_create.
19*1031c584SApple OSS Distributions</dl>
20*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
21*1031c584SApple OSS Distributions<p>
22*1031c584SApple OSS DistributionsThe <strong>default_pager_backing_store_delete</strong> function is called to destroy a
23*1031c584SApple OSS Distributionsbacking storage object created by
24*1031c584SApple OSS Distributions<strong>default_pager_backing_store_create</strong>. The kernel does not make this call
25*1031c584SApple OSS Distributionsitself (which is why it can be a synchronous call); this request is
26*1031c584SApple OSS Distributionsonly issued by tasks holding the backing store port, created with
27*1031c584SApple OSS Distributions<strong>default_pager_backing_store_create</strong>, for a default memory manager.
28*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
29*1031c584SApple OSS Distributions<dl>
30*1031c584SApple OSS Distributions<p>
31*1031c584SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
32*1031c584SApple OSS Distributions<dd>
33*1031c584SApple OSS DistributionsThe default pager does not support this operation.
34*1031c584SApple OSS Distributions<p>
35*1031c584SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong>
36*1031c584SApple OSS Distributions<dd>
37*1031c584SApple OSS DistributionsThe backing_store port does not represent a valid backing store or the
38*1031c584SApple OSS Distributionsspecified segment overlaps an existing partition.
39*1031c584SApple OSS Distributions<p>
40*1031c584SApple OSS Distributions<dt> <strong>KERN_SUCCESS</strong>
41*1031c584SApple OSS Distributions<dd>
42*1031c584SApple OSS DistributionsThe operation was successful.
43*1031c584SApple OSS Distributions</dl>
44*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
45*1031c584SApple OSS Distributions<p>
46*1031c584SApple OSS DistributionsFunctions:
47*1031c584SApple OSS Distributions<a href="DP_backing_store_create.html"><strong>default_pager_backing_store_create</strong></a>,
48*1031c584SApple OSS Distributions<a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.
49