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

<h2>default_pager_info</h2>\r<hr>\r<p>\r<strong>Server Interface</strong> - Furnish caller with information about the pager's paging partition.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   default_pager_info</strong>\r                <strong>(mach_port_t</strong>                              <var>pager</var>,\r                 <strong>default_pager_info_t</strong>                      <var>info</var><strong>);</strong>\r\r\r<strong>kern_return_t   seqnos_default_pager_info</strong>\r                <strong>(mach_port_t</strong>                              <var>pager</var>,\r                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,\r                 <strong>default_pager_info_t</strong>                     <var>*info</var><strong>);</strong>\r\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>pager</var> \r<dd>\r[in default-pager (receive) right]\rThe default memory manager service \rport.\r<p>\r<dt> <var>seqno</var> \r<dd>\r[in scalar]\rThe sequence number of this message relative to the pager \rport.\r<p>\r<dt> <var>info</var> \r<dd>\r[out structure]\rTotal and free space consumption.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rA <strong>default_pager_info</strong> function is called as the result\rof a message requesting \rthat the default memory manager return information concerning the default\rpager's paging partitions.  The kernel does not make this call\ritself (which is why it \rcan be a synchronous call); this request is only issued by (privileged) tasks\rholding the default memory manager port.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="HD_memory_manager.html"><strong>vm_set_default_memory_manager</strong></a>,\r<a href="MO_default_server.html"><strong>memory_object_default_server</strong></a>,\r<a href="SMO_default_server.html"><strong>seqnos_memory_object_default_server</strong></a>.\r<p>\rData Structures:\r<a href="default_pager_info.html"><strong>default_pager_info</strong></a>.\r