1*c54f35caSApple OSS Distributions<h2>memory_object_destroy</h2> 2*c54f35caSApple OSS Distributions<hr> 3*c54f35caSApple OSS Distributions<p> 4*c54f35caSApple OSS Distributions<strong>Function</strong> - Shut down a memory object. 5*c54f35caSApple OSS Distributions<h3>SYNOPSIS</h3> 6*c54f35caSApple OSS Distributions<pre> 7*c54f35caSApple OSS Distributions<strong>kern_return_t memory_object_destroy</strong> 8*c54f35caSApple OSS Distributions <strong>(memory_object_control_t</strong> <var>memory_control</var>, 9*c54f35caSApple OSS Distributions <strong>kern_return_t</strong> <var>reason</var><strong>);</strong> 10*c54f35caSApple OSS Distributions</pre> 11*c54f35caSApple OSS Distributions<h3>PARAMETERS</h3> 12*c54f35caSApple OSS Distributions<dl> 13*c54f35caSApple OSS Distributions<p> 14*c54f35caSApple OSS Distributions<dt> <var>memory_control</var> 15*c54f35caSApple OSS Distributions<dd> 16*c54f35caSApple OSS Distributions[in memory-cache-control send right] 17*c54f35caSApple OSS DistributionsThe memory cache control port 18*c54f35caSApple OSS Distributionsto be used by the memory manager for cache management requests. 19*c54f35caSApple OSS DistributionsThis port is provided by the kernel in a <strong>memory_object_init</strong> call. 20*c54f35caSApple OSS Distributions<p> 21*c54f35caSApple OSS Distributions<dt> <var>reason</var> 22*c54f35caSApple OSS Distributions<dd> 23*c54f35caSApple OSS Distributions[in scalar] 24*c54f35caSApple OSS DistributionsAn error code indicating when the object must be destroyed. 25*c54f35caSApple OSS Distributions</dl> 26*c54f35caSApple OSS Distributions<h3>DESCRIPTION</h3> 27*c54f35caSApple OSS Distributions<p> 28*c54f35caSApple OSS DistributionsThe <strong>memory_object_destroy</strong> function tells the kernel to shut down the 29*c54f35caSApple OSS Distributionsspecified memory object. As a result of this call, the kernel 30*c54f35caSApple OSS Distributionsno longer supports 31*c54f35caSApple OSS Distributionspaging activity or any memory object calls on the memory object. 32*c54f35caSApple OSS DistributionsThe kernel issues 33*c54f35caSApple OSS Distributionsa <strong>memory_object_terminate</strong> call to pass to the memory 34*c54f35caSApple OSS Distributionsmanager all rights to 35*c54f35caSApple OSS Distributionsthe memory object port and the memory control port. 36*c54f35caSApple OSS Distributions<p> 37*c54f35caSApple OSS DistributionsTo ensure that any modified cached data is returned before the object is 38*c54f35caSApple OSS Distributionsterminated, the memory manager should call <strong>memory_object_lock_request</strong> 39*c54f35caSApple OSS Distributionswith 40*c54f35caSApple OSS Distributions<var>should_flush</var> set and a 41*c54f35caSApple OSS Distributionslock value of <strong>VM_PROT_WRITE</strong> before it makes the 42*c54f35caSApple OSS Distributions<strong>memory_object_destroy</strong> call. 43*c54f35caSApple OSS Distributions<h3>NOTES</h3> 44*c54f35caSApple OSS Distributions<p> 45*c54f35caSApple OSS DistributionsThe <var>reason</var> code is currently ignored by the kernel. 46*c54f35caSApple OSS Distributions<h3>RETURN VALUES</h3> 47*c54f35caSApple OSS Distributions<p> 48*c54f35caSApple OSS DistributionsOnly generic errors apply. 49*c54f35caSApple OSS Distributions<h3>RELATED INFORMATION</h3> 50*c54f35caSApple OSS Distributions<p> 51*c54f35caSApple OSS DistributionsFunctions: 52*c54f35caSApple OSS Distributions<a href="memory_object_lock_request.html"><strong>memory_object_lock_request</strong></a>, 53*c54f35caSApple OSS Distributions<a href="memory_object_terminate.html"><strong>memory_object_terminate</strong></a>. 54