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