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