Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_d_driver1_factory.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: DDriver1Factory Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>DDriver1Factory Class Reference</h1><!-- doxytag: class="DDriver1Factory" -->
<p>
<a href="class_d_driver1_factory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_driver1_factory.html#28b03d2a83e475c0ef628d87f574b326">DDriver1Factory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_driver1_factory.html#2826ff8e0deb203cdabd8a5d31d4eccd">~DDriver1Factory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_driver1_factory.html#7aa17c3f9b4d020f1d48fa89bf587452">Install</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_driver1_factory.html#f6c76eec10ac39e32d1095b9b3a7ecc0">GetCaps</a> (TDes8 &aDes) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_driver1_factory.html#2c28467be74fbe3022b3ae998c18894a">Create</a> (DLogicalChannelBase *&aChannel)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Logical Device (factory class) for 'Driver1'
<p>Definition at line <a class="el" href="driver1__dev_8h-source.html#l00029">29</a> of file <a class="el" href="driver1__dev_8h-source.html">driver1_dev.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="28b03d2a83e475c0ef628d87f574b326"></a><!-- doxytag: member="DDriver1Factory::DDriver1Factory" ref="28b03d2a83e475c0ef628d87f574b326" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DDriver1Factory::DDriver1Factory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor
<p>Definition at line <a class="el" href="driver1__ldd_8cpp-source.html#l00045">45</a> of file <a class="el" href="driver1__ldd_8cpp-source.html">driver1_ldd.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2826ff8e0deb203cdabd8a5d31d4eccd"></a><!-- doxytag: member="DDriver1Factory::~DDriver1Factory" ref="2826ff8e0deb203cdabd8a5d31d4eccd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DDriver1Factory::~DDriver1Factory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
<p>Definition at line <a class="el" href="driver1__ldd_8cpp-source.html#l00067">67</a> of file <a class="el" href="driver1__ldd_8cpp-source.html">driver1_ldd.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7aa17c3f9b4d020f1d48fa89bf587452"></a><!-- doxytag: member="DDriver1Factory::Install" ref="7aa17c3f9b4d020f1d48fa89bf587452" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt DDriver1Factory::Install </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Second stage constructor for <a class="el" href="class_d_driver1_factory.html">DDriver1Factory</a>. This must at least sets a name for the driver object.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="driver1__ldd_8cpp-source.html#l00059">59</a> of file <a class="el" href="driver1__ldd_8cpp-source.html">driver1_ldd.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="f6c76eec10ac39e32d1095b9b3a7ecc0"></a><!-- doxytag: member="DDriver1Factory::GetCaps" ref="f6c76eec10ac39e32d1095b9b3a7ecc0" args="(TDes8 &aDes) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DDriver1Factory::GetCaps </td>
<td>(</td>
<td class="paramtype">TDes8 & </td>
<td class="paramname"> <em>aDes</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the driver's capabilities. Called in response to an RDevice::GetCaps() request. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>User-side descriptor to write capabilities information into. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="driver1__ldd_8cpp-source.html#l00076">76</a> of file <a class="el" href="driver1__ldd_8cpp-source.html">driver1_ldd.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2c28467be74fbe3022b3ae998c18894a"></a><!-- doxytag: member="DDriver1Factory::Create" ref="2c28467be74fbe3022b3ae998c18894a" args="(DLogicalChannelBase *&aChannel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt DDriver1Factory::Create </td>
<td>(</td>
<td class="paramtype">DLogicalChannelBase *& </td>
<td class="paramname"> <em>aChannel</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called by the kernel's device driver framework to create a Logical Channel. This is called in the context of the user thread (client) which requested the creation of a Logical Channel (e.g. through a call to RBusLogicalChannel::DoCreate). The thread is in a critical section. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aChannel</em> </td><td>The created Logical Channel </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="driver1__ldd_8cpp-source.html#l00093">93</a> of file <a class="el" href="driver1__ldd_8cpp-source.html">driver1_ldd.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>