Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 6c21d55247420ace69cad1d05267fc34 > files > 180

pcsc-lite-doc-1.7.2-4.fc15.noarch.rpm

<!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/xhtml;charset=UTF-8"/>
<title>pcsc-lite: prothandler.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">pcsc-lite&#160;<span id="projectnumber">1.7.2</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="dir_7a4553ee0c3b13d0e595a5d1659110a6.html">src</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">prothandler.h File Reference</div>  </div>
</div>
<div class="contents">

<p>This handles protocol defaults, PTS, etc.  
<a href="#details">More...</a></p>
<div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="prothandler_8h__dep__incl.png" border="0" usemap="#prothandler_8hdep" alt=""/></div>
<map name="prothandler_8hdep" id="prothandler_8hdep">
<area shape="rect" id="node3" href="eventhandler_8c.html" title="This keeps track of card insertion/removal events and updates ATR, protocol, and status information..." alt="" coords="5,83,112,112"/><area shape="rect" id="node5" href="prothandler_8c.html" title="This handles protocol defaults, PTS, etc." alt="" coords="136,83,232,112"/><area shape="rect" id="node7" href="winscard_8c.html" title="This handles smartcard reader communications." alt="" coords="256,83,341,112"/></map>
</div>
</div>
<p><a href="prothandler_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a719a4cc70475733ac04ade1a4f92e845"></a><!-- doxytag: member="prothandler.h::SET_PROTOCOL_WRONG_ARGUMENT" ref="a719a4cc70475733ac04ade1a4f92e845" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SET_PROTOCOL_WRONG_ARGUMENT</b>&#160;&#160;&#160;-1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50b3b4819bdc3aeba53ff8b005c7a407"></a><!-- doxytag: member="prothandler.h::SET_PROTOCOL_PPS_FAILED" ref="a50b3b4819bdc3aeba53ff8b005c7a407" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SET_PROTOCOL_PPS_FAILED</b>&#160;&#160;&#160;-2</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">UCHAR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="prothandler_8h.html#ab90a8ce8ccece0e82beb131d99e42724">PHGetDefaultProtocol</a> (PUCHAR, DWORD)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the default protocol used immediately after reset.  <a href="#ab90a8ce8ccece0e82beb131d99e42724"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">UCHAR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="prothandler_8h.html#ae1bf5f71af644725f12dcdb2e26e4111">PHGetAvailableProtocols</a> (PUCHAR, DWORD)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the protocols supported by the card.  <a href="#ae1bf5f71af644725f12dcdb2e26e4111"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DWORD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="prothandler_8h.html#a3f27bce2e5c3ba9e7d97240d6c01a746">PHSetProtocol</a> (struct <a class="el" href="structReaderContext.html">ReaderContext</a> *, DWORD, UCHAR, UCHAR)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine which protocol to use.  <a href="#a3f27bce2e5c3ba9e7d97240d6c01a746"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This handles protocol defaults, PTS, etc. </p>

<p>Definition in file <a class="el" href="prothandler_8h_source.html">prothandler.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae1bf5f71af644725f12dcdb2e26e4111"></a><!-- doxytag: member="prothandler.h::PHGetAvailableProtocols" ref="ae1bf5f71af644725f12dcdb2e26e4111" args="(PUCHAR, DWORD)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UCHAR PHGetAvailableProtocols </td>
          <td>(</td>
          <td class="paramtype">PUCHAR&#160;</td>
          <td class="paramname"><em>pucAtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">DWORD&#160;</td>
          <td class="paramname"><em>dwLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the protocols supported by the card. </p>
<p>These protocols are returned from the function as bit masks. </p>

<p>Definition at line <a class="el" href="prothandler_8c_source.html#l00054">54</a> of file <a class="el" href="prothandler_8c_source.html">prothandler.c</a>.</p>

<p>References <a class="el" href="atrhandler_8c_source.html#l00044">ATRDecodeAtr()</a>.</p>

<p>Referenced by <a class="el" href="winscard_8c_source.html#l00209">SCardConnect()</a>, and <a class="el" href="winscard_8c_source.html#l00491">SCardReconnect()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="prothandler_8h_ae1bf5f71af644725f12dcdb2e26e4111_cgraph.png" border="0" usemap="#prothandler_8h_ae1bf5f71af644725f12dcdb2e26e4111_cgraph" alt=""/></div>
<map name="prothandler_8h_ae1bf5f71af644725f12dcdb2e26e4111_cgraph" id="prothandler_8h_ae1bf5f71af644725f12dcdb2e26e4111_cgraph">
<area shape="rect" id="node3" href="atrhandler_8c.html#a76bf3383cc11cc95499325c987d6f193" title="Uncomment the following for ATR debugging or use ." alt="" coords="225,5,335,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="ab90a8ce8ccece0e82beb131d99e42724"></a><!-- doxytag: member="prothandler.h::PHGetDefaultProtocol" ref="ab90a8ce8ccece0e82beb131d99e42724" args="(PUCHAR, DWORD)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UCHAR PHGetDefaultProtocol </td>
          <td>(</td>
          <td class="paramtype">PUCHAR&#160;</td>
          <td class="paramname"><em>pucAtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">DWORD&#160;</td>
          <td class="paramname"><em>dwLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the default protocol used immediately after reset. </p>
<p>This protocol is returned from the function. </p>

<p>Definition at line <a class="el" href="prothandler_8c_source.html#l00034">34</a> of file <a class="el" href="prothandler_8c_source.html">prothandler.c</a>.</p>

<p>References <a class="el" href="atrhandler_8c_source.html#l00044">ATRDecodeAtr()</a>.</p>

<p>Referenced by <a class="el" href="winscard_8c_source.html#l00209">SCardConnect()</a>, and <a class="el" href="winscard_8c_source.html#l00491">SCardReconnect()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="prothandler_8h_ab90a8ce8ccece0e82beb131d99e42724_cgraph.png" border="0" usemap="#prothandler_8h_ab90a8ce8ccece0e82beb131d99e42724_cgraph" alt=""/></div>
<map name="prothandler_8h_ab90a8ce8ccece0e82beb131d99e42724_cgraph" id="prothandler_8h_ab90a8ce8ccece0e82beb131d99e42724_cgraph">
<area shape="rect" id="node3" href="atrhandler_8c.html#a76bf3383cc11cc95499325c987d6f193" title="Uncomment the following for ATR debugging or use ." alt="" coords="207,5,316,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a3f27bce2e5c3ba9e7d97240d6c01a746"></a><!-- doxytag: member="prothandler.h::PHSetProtocol" ref="a3f27bce2e5c3ba9e7d97240d6c01a746" args="(struct ReaderContext *, DWORD, UCHAR, UCHAR)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DWORD PHSetProtocol </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structReaderContext.html">ReaderContext</a> *&#160;</td>
          <td class="paramname"><em>rContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">DWORD&#160;</td>
          <td class="paramname"><em>dwPreferred</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UCHAR&#160;</td>
          <td class="paramname"><em>ucAvailable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UCHAR&#160;</td>
          <td class="paramname"><em>ucDefault</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Determine which protocol to use. </p>
<p>SCardConnect has a DWORD dwPreferredProtocols that is a bitmask of what protocols to use. Basically, if T=N where N is not zero will be used first if it is available in ucAvailable. Otherwise it will always default to T=0.</p>
<p><a class="el" href="ifdwrapper_8c.html#ad794bea544918757cd2fbbae218fa458" title="Set the protocol type selection (PTS).">IFDSetPTS()</a> is _always_ called so that the driver can initialise its data </p>

<p>Definition at line <a class="el" href="prothandler_8c_source.html#l00079">79</a> of file <a class="el" href="prothandler_8c_source.html">prothandler.c</a>.</p>

<p>References <a class="el" href="ifdhandler_8h_source.html#l00341">IFD_NOT_SUPPORTED</a>, <a class="el" href="ifdhandler_8h_source.html#l00334">IFD_PROTOCOL_NOT_SUPPORTED</a>, <a class="el" href="ifdhandler_8h_source.html#l00328">IFD_SUCCESS</a>, <a class="el" href="ifdwrapper_8c_source.html#l00046">IFDSetPTS()</a>, <a class="el" href="pcsclite_8h_source.html#l00152">SCARD_PROTOCOL_T0</a>, and <a class="el" href="pcsclite_8h_source.html#l00153">SCARD_PROTOCOL_T1</a>.</p>

<p>Referenced by <a class="el" href="winscard_8c_source.html#l00209">SCardConnect()</a>, and <a class="el" href="winscard_8c_source.html#l00491">SCardReconnect()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="prothandler_8h_a3f27bce2e5c3ba9e7d97240d6c01a746_cgraph.png" border="0" usemap="#prothandler_8h_a3f27bce2e5c3ba9e7d97240d6c01a746_cgraph" alt=""/></div>
<map name="prothandler_8h_a3f27bce2e5c3ba9e7d97240d6c01a746_cgraph" id="prothandler_8h_a3f27bce2e5c3ba9e7d97240d6c01a746_cgraph">
<area shape="rect" id="node3" href="ifdwrapper_8c.html#ad794bea544918757cd2fbbae218fa458" title="Set the protocol type selection (PTS)." alt="" coords="163,5,253,35"/><area shape="rect" id="node5" href="group__IFDHandler.html#gaa6fc195cb450a147550f4671492257ad" title="This function should set the Protocol Type Selection (PTS) of a particular card/slot using the three ..." alt="" coords="301,5,491,35"/></map>
</div>
</p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for pcsc-lite by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>