Sophie

Sophie

distrib > CentOS > 6 > i386 > by-pkgid > 2c51d8eb79f8810ada971ee8c30ce1e5 > files > 312

kernel-doc-2.6.32-71.14.1.el6.noarch.rpm

<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>kobject_add</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="Linux Device Drivers" /><link rel="up" href="ch01s07.html" title="Kernel objects manipulation" /><link rel="prev" href="re118.html" title="kobject_init" /><link rel="next" href="re120.html" title="kobject_init_and_add" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>kobject_add</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re118.html">Prev</a>&#160;</td><th width="60%" align="center">Kernel objects manipulation</th><td width="20%" align="right">&#160;<a accesskey="n" href="re120.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="kobject_add"><a id="API-kobject-add"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kobject_add &#8212; 
     the main kobject add function
 </p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int <b class="fsfunc">kobject_add </b>(</code></td><td>struct kobject * <var class="pdparam">kobj</var>, </td></tr><tr><td>&#160;</td><td>struct kobject * <var class="pdparam">parent</var>, </td></tr><tr><td>&#160;</td><td>const char * <var class="pdparam">fmt</var>, </td></tr><tr><td>&#160;</td><td> <var class="pdparam">...</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1" title="Arguments"><a id="id2610338"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>kobj</code></em></span></dt><dd><p>
     the kobject to add
    </p></dd><dt><span class="term"><em class="parameter"><code>parent</code></em></span></dt><dd><p>
     pointer to the parent of the kobject.
    </p></dd><dt><span class="term"><em class="parameter"><code>fmt</code></em></span></dt><dd><p>
     format to name the kobject with.
    </p></dd><dt><span class="term"><em class="parameter"><code>...</code></em></span></dt><dd><p>
     variable arguments
    </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id2610416"></a><h2>Description</h2><p>
   The kobject name is set and added to the kobject hierarchy in this
   function.
   </p><p>

   If <em class="parameter"><code>parent</code></em> is set, then the parent of the <em class="parameter"><code>kobj</code></em> will be set to it.
   If <em class="parameter"><code>parent</code></em> is NULL, then the parent of the <em class="parameter"><code>kobj</code></em> will be set to the
   kobject associted with the kset assigned to this kobject.  If no kset
   is assigned to the kobject, then the kobject will be located in the
   root of the sysfs tree.
   </p><p>

   If this function returns an error, <code class="function">kobject_put</code> must be called to
   properly clean up the memory associated with the object.
   Under no instance should the kobject that is passed to this function
   be directly freed with a call to <code class="function">kfree</code>, that can leak memory.
   </p><p>

   Note, no <span class="quote">&#8220;<span class="quote">add</span>&#8221;</span> uevent will be created with this call, the caller should set
   up all of the necessary sysfs files for the object and then call
   <code class="function">kobject_uevent</code> with the UEVENT_ADD parameter to ensure that
   userspace is properly notified of this kobject's creation.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re118.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch01s07.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="re120.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>kobject_init</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span>kobject_init_and_add</span></td></tr></table></div></body></html>