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