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

<h2>default_pager_backing_store_create</h2>\r<hr>\r<p>\r<strong>Server Interface</strong> - Create 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_create</strong>\r                <strong>(mach_port_t</strong>                              <var>pager</var>,\r                 <strong>int</strong>                                   <var>priority</var>,\r                 <strong>int</strong>                                     <var>clsize</var>,\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>pager</var>\r<dd>\r[in default pager (receive) right] The default pager service port.\r<p>\r<dt> <var>priority</var>\r<dd>\r[in scalar] The scheduling priority for the backing store service \rthread(s).\r<p>\r<dt> <var>clsize</var>\r<dd>\r[in scalar] The preferred cluster size (in bytes) for the backing\rstore object.\r<p>\r<dt> <var>backing_store</var>\r<dd>\r[out backing store (receive) right] The port used to manipulate the\rcreated backing store.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>default_pager_backing_store_create</strong> function is called to create a\rnew backing storage object. The kernel does not make this call itself\r(which is why it can be a synchronous call); this request is only\rissued by tasks (privileged) holding the default pager service port.\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 pager port does not represent a valid default pager.\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_delete.html"><strong>default_pager_backing_store_delete</strong></a>,\r<a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.\r