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