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