[apple/xnu.git] / osfmk / man / DP_backing_store_delete.html

<h2>default_pager_backing_store_delete</h2>\r<hr>\r<p>\r<strong>Server Interface</strong> - Delete a backing storage object.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&lt mach/default_pager_object.h&gt</strong>\r\r<strong>kern_return_t   default_pager_backing_store_delete</strong>\r                <strong>(mach_port_t</strong>                      <var>backing_store</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>backing_store</var>\r<dd>\r[in backing store (receive) right] The backing store port created by \rdefault_pager_backing_store_create.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>default_pager_backing_store_delete</strong> function is called to destroy a\rbacking storage object created by\r<strong>default_pager_backing_store_create</strong>. The kernel does not make this call\ritself (which is why it can be a synchronous call); this request is\ronly issued by tasks holding the backing store port, created with\r<strong>default_pager_backing_store_create</strong>, for a default memory manager.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_FAILURE</strong>\r<dd>\rThe default pager does not support this operation.\r<p>\r<dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\rThe backing_store port does not represent a valid backing store or the \rspecified segment overlaps an existing partition.\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe operation was successful.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="DP_backing_store_create.html"><strong>default_pager_backing_store_create</strong></a>,\r<a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.\r