<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>UareU SDK .Net API: Reader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UareU SDK .Net API
   </div>
   <div id="projectbrief">Documentation describing the API for the UareU SDK .Net Wrapper</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Events</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_d_p_uru_net.html">DPUruNet</a></li><li class="navelem"><a class="el" href="class_d_p_uru_net_1_1_reader.html">Reader</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_d_p_uru_net_1_1_reader-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Reader Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents the a physical fingerprint reader. Contains methods to capture and stream an <a class="el" href="class_d_p_uru_net_1_1_fid.html" title="Class represents Fingerprint Image Data (FID).">Fid</a>. Contains details about the reader, its capabilities, and current status.  
 <a href="class_d_p_uru_net_1_1_reader.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Reader:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_d_p_uru_net_1_1_reader.png" usemap="#Reader_map" alt=""/>
  <map id="Reader_map" name="Reader_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_capabilities.html">ReaderCapabilities</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains information about reader capabilities (i.e., can capture, can stream, ...)  <a href="class_d_p_uru_net_1_1_reader_1_1_reader_capabilities.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_description.html">ReaderDescription</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains complete information about reader hardware.  <a href="class_d_p_uru_net_1_1_reader_1_1_reader_description.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_status.html">ReaderStatus</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container class describing status of the reader.  <a href="class_d_p_uru_net_1_1_reader_1_1_reader_status.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac6d8d5e1ad3db4924d1382df824fa288"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_capture_result.html">CaptureResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#ac6d8d5e1ad3db4924d1382df824fa288">Capture</a> (<a class="el" href="class_d_p_uru_net_1_1_constants_1_1_formats.html#a9c3f7837f73c6d25975a726f637a7b3d">Constants.Formats.Fid</a> format, <a class="el" href="class_d_p_uru_net_1_1_constants.html#a3fbbb7252fef36c2c2741795be0b8fbe">Constants.CaptureProcessing</a> processing, int timeout, int resolution)</td></tr>
<tr class="memdesc:ac6d8d5e1ad3db4924d1382df824fa288"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function captures a fingerprint image from the opened reader device. This function signals the device that a fingerprint is expected and waits until a fingerprint is received. This function blocks until an image is captured, capture fails or timeout is expired. This function cannot be called in streaming mode. If memory is not sufficient for the image, then DP_E_MORE_DATA will be returned.  <a href="#ac6d8d5e1ad3db4924d1382df824fa288"></a><br/></td></tr>
<tr class="separator:ac6d8d5e1ad3db4924d1382df824fa288"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5375a08c840f367e9f54b262058c5f3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a5375a08c840f367e9f54b262058c5f3d">CancelCapture</a> ()</td></tr>
<tr class="memdesc:a5375a08c840f367e9f54b262058c5f3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancels pending capture.  <a href="#a5375a08c840f367e9f54b262058c5f3d"></a><br/></td></tr>
<tr class="separator:a5375a08c840f367e9f54b262058c5f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8969fe616ee9c1ac3113ffcadffa8da1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a8969fe616ee9c1ac3113ffcadffa8da1">StartStreaming</a> ()</td></tr>
<tr class="memdesc:a8969fe616ee9c1ac3113ffcadffa8da1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts reader into streaming mode.  <a href="#a8969fe616ee9c1ac3113ffcadffa8da1"></a><br/></td></tr>
<tr class="separator:a8969fe616ee9c1ac3113ffcadffa8da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1af5e9c6db313d3bf9d95b709a8ea09a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_capture_result.html">CaptureResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a1af5e9c6db313d3bf9d95b709a8ea09a">GetStreamImage</a> (<a class="el" href="class_d_p_uru_net_1_1_constants_1_1_formats.html#a9c3f7837f73c6d25975a726f637a7b3d">Constants.Formats.Fid</a> format, <a class="el" href="class_d_p_uru_net_1_1_constants.html#a3fbbb7252fef36c2c2741795be0b8fbe">Constants.CaptureProcessing</a> processing, int resolution)</td></tr>
<tr class="memdesc:a1af5e9c6db313d3bf9d95b709a8ea09a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Takes an image from the stream.  <a href="#a1af5e9c6db313d3bf9d95b709a8ea09a"></a><br/></td></tr>
<tr class="separator:a1af5e9c6db313d3bf9d95b709a8ea09a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab1ee94f63b91dd95672255b8f6275dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#aab1ee94f63b91dd95672255b8f6275dd">StopStreaming</a> ()</td></tr>
<tr class="memdesc:aab1ee94f63b91dd95672255b8f6275dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops streaming mode  <a href="#aab1ee94f63b91dd95672255b8f6275dd"></a><br/></td></tr>
<tr class="separator:aab1ee94f63b91dd95672255b8f6275dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbec2a199a4b0b6b6984398037836c5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#abbec2a199a4b0b6b6984398037836c5c">Open</a> (<a class="el" href="class_d_p_uru_net_1_1_constants.html#ac5ad713a38e4f3d406c3ed43ed688fb6">Constants.CapturePriority</a> priority)</td></tr>
<tr class="memdesc:abbec2a199a4b0b6b6984398037836c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a reader and populates <a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_capabilities.html" title="Contains information about reader capabilities (i.e., can capture, can stream, ...) ">ReaderCapabilities</a> sub-class.  <a href="#abbec2a199a4b0b6b6984398037836c5c"></a><br/></td></tr>
<tr class="separator:abbec2a199a4b0b6b6984398037836c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e2d745cdb7a7b983f861ed6a9a541a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a6e2d745cdb7a7b983f861ed6a9a541a7">Dispose</a> ()</td></tr>
<tr class="memdesc:a6e2d745cdb7a7b983f861ed6a9a541a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the reader.  <a href="#a6e2d745cdb7a7b983f861ed6a9a541a7"></a><br/></td></tr>
<tr class="separator:a6e2d745cdb7a7b983f861ed6a9a541a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad203b4b412d27790ac1f18e23fdc1444"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#ad203b4b412d27790ac1f18e23fdc1444">Calibrate</a> ()</td></tr>
<tr class="memdesc:ad203b4b412d27790ac1f18e23fdc1444"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calibrates the reader.  <a href="#ad203b4b412d27790ac1f18e23fdc1444"></a><br/></td></tr>
<tr class="separator:ad203b4b412d27790ac1f18e23fdc1444"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ad7a00fd20da92640c6c7f42f8542ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a9ad7a00fd20da92640c6c7f42f8542ac">GetStatus</a> ()</td></tr>
<tr class="memdesc:a9ad7a00fd20da92640c6c7f42f8542ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populates the <a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_status.html" title="Container class describing status of the reader. ">ReaderStatus</a> sub-class.  <a href="#a9ad7a00fd20da92640c6c7f42f8542ac"></a><br/></td></tr>
<tr class="separator:a9ad7a00fd20da92640c6c7f42f8542ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa3ba68bb9799b755351f13f1f223cdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#afa3ba68bb9799b755351f13f1f223cdc">Reset</a> ()</td></tr>
<tr class="memdesc:afa3ba68bb9799b755351f13f1f223cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the reader.  <a href="#afa3ba68bb9799b755351f13f1f223cdc"></a><br/></td></tr>
<tr class="separator:afa3ba68bb9799b755351f13f1f223cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a130823283672d817d178c0d145cd9fd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_description.html">ReaderDescription</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a130823283672d817d178c0d145cd9fd9">Description</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a130823283672d817d178c0d145cd9fd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Complete information about the reader hardware.  <a href="#a130823283672d817d178c0d145cd9fd9"></a><br/></td></tr>
<tr class="separator:a130823283672d817d178c0d145cd9fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2336a1c410d5a55d758d10e2479fc15e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_status.html">ReaderStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a2336a1c410d5a55d758d10e2479fc15e">Status</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a2336a1c410d5a55d758d10e2479fc15e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container class to hold reader status.  <a href="#a2336a1c410d5a55d758d10e2479fc15e"></a><br/></td></tr>
<tr class="separator:a2336a1c410d5a55d758d10e2479fc15e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8adc65903ba9b324a4819f62573b0335"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_capabilities.html">ReaderCapabilities</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_p_uru_net_1_1_reader.html#a8adc65903ba9b324a4819f62573b0335">Capabilities</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a8adc65903ba9b324a4819f62573b0335"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains information about reader capabilities (i.e., can capture, can stream, ...)  <a href="#a8adc65903ba9b324a4819f62573b0335"></a><br/></td></tr>
<tr class="separator:a8adc65903ba9b324a4819f62573b0335"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents the a physical fingerprint reader. Contains methods to capture and stream an <a class="el" href="class_d_p_uru_net_1_1_fid.html" title="Class represents Fingerprint Image Data (FID).">Fid</a>. Contains details about the reader, its capabilities, and current status. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac6d8d5e1ad3db4924d1382df824fa288"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_capture_result.html">CaptureResult</a> Capture </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_d_p_uru_net_1_1_constants_1_1_formats.html#a9c3f7837f73c6d25975a726f637a7b3d">Constants.Formats.Fid</a>&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_d_p_uru_net_1_1_constants.html#a3fbbb7252fef36c2c2741795be0b8fbe">Constants.CaptureProcessing</a>&#160;</td>
          <td class="paramname"><em>processing</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>timeout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>resolution</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function captures a fingerprint image from the opened reader device. This function signals the device that a fingerprint is expected and waits until a fingerprint is received. This function blocks until an image is captured, capture fails or timeout is expired. This function cannot be called in streaming mode. If memory is not sufficient for the image, then DP_E_MORE_DATA will be returned. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Format of the image</td></tr>
    <tr><td class="paramname">processing</td><td>Processing of the image</td></tr>
    <tr><td class="paramname">timeout</td><td>Timeout in milliseconds; -1 means no timeout (function will block until a fingerprint is captured or a cancel is caused)</td></tr>
    <tr><td class="paramname">resolution</td><td>Resolution of the image</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: Image captured. Extended result is in capture_result; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_DEVICE_BUSY: Another operation is in progress; DPFPDD_E_INVALID_PARAMETER: Wrong data type or image format in the capture_parm; DPFPDD_E_DEVICE_FAILURE: Failed to start capture, reader is not functioning properly. </dd></dl>

</div>
</div>
<a class="anchor" id="a5375a08c840f367e9f54b262058c5f3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> CancelCapture </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancels pending capture. </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: Capture canceled; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_DEVICE_FAILURE: Failed to cancel capture, reader is not functioning properly. </dd></dl>

</div>
</div>
<a class="anchor" id="a8969fe616ee9c1ac3113ffcadffa8da1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> StartStreaming </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Puts reader into streaming mode. </p>
<p>Not all readers support this mode. When the reader is in streaming mode, the application can only call <a class="el" href="class_d_p_uru_net_1_1_reader.html#a1af5e9c6db313d3bf9d95b709a8ea09a" title="Takes an image from the stream.">GetStreamImage()</a> to acquire images from the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: <a class="el" href="class_d_p_uru_net_1_1_reader.html" title="Represents the a physical fingerprint reader. Contains methods to capture and stream an Fid...">Reader</a> put into streaming mode; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_INVALID_PARAMETER: Wrong data type or image format in the capture_parm; DPFPDD_E_DEVICE_BUSY: Another operation is in progress; DPFPDD_E_DEVICE_FAILURE: Failed to start streaming, reader is not functioning properly. </dd></dl>

</div>
</div>
<a class="anchor" id="a1af5e9c6db313d3bf9d95b709a8ea09a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_capture_result.html">CaptureResult</a> GetStreamImage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_d_p_uru_net_1_1_constants_1_1_formats.html#a9c3f7837f73c6d25975a726f637a7b3d">Constants.Formats.Fid</a>&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_d_p_uru_net_1_1_constants.html#a3fbbb7252fef36c2c2741795be0b8fbe">Constants.CaptureProcessing</a>&#160;</td>
          <td class="paramname"><em>processing</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>resolution</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Takes an image from the stream. </p>
<p>After the reader is put into streaming mode this function takes an image from the stream. After this function returns, the reader stays in the streaming mode. Frame selection, scoring or other image processing is not performed.</p>
<p>If the memory is not sufficient for the image, then DPFPDD_E_MORE_DATA will be returned. For every image from the stream, the driver provides a score (in capture_result.score) and quality feedback (in capture_result.quailty). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>Format of the image</td></tr>
    <tr><td class="paramname">processing</td><td>Processing of the image</td></tr>
    <tr><td class="paramname">resolution</td><td>Resolution of the image</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: Image acquired from the stream. Extended result is in capture_result; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_DEVICE_BUSY: Another operation is in progress; DPFPDD_E_MORE_DATA: Insufficient memory is allocated for the image_data, the required size is in the image_size; DPFPDD_E_INVALID_PARAMETER: Wrong data type or image format in the capture_parm; DPFPDD_E_DEVICE_FAILURE: Failed to acquire image from the stream, reader is not functioning properly. </dd></dl>

</div>
</div>
<a class="anchor" id="aab1ee94f63b91dd95672255b8f6275dd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> StopStreaming </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops streaming mode </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: Streaming was stopped; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_DEVICE_FAILURE: Failed to stop streaming, reader is not functioning properly. </dd></dl>

</div>
</div>
<a class="anchor" id="abbec2a199a4b0b6b6984398037836c5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> Open </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ac5ad713a38e4f3d406c3ed43ed688fb6">Constants.CapturePriority</a>&#160;</td>
          <td class="paramname"><em>priority</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Opens a reader and populates <a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_capabilities.html" title="Contains information about reader capabilities (i.e., can capture, can stream, ...) ">ReaderCapabilities</a> sub-class. </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: <a class="el" href="class_d_p_uru_net_1_1_reader.html" title="Represents the a physical fingerprint reader. Contains methods to capture and stream an Fid...">Reader</a> was successfullly opened; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: No reader with this name found; DPFPDD_E_DEVICE_BUSY: <a class="el" href="class_d_p_uru_net_1_1_reader.html" title="Represents the a physical fingerprint reader. Contains methods to capture and stream an Fid...">Reader</a> is already opened by the same or another process; DPFPDD_E_DEVICE_FAILURE: Failed to open the reader. </dd></dl>

</div>
</div>
<a class="anchor" id="a6e2d745cdb7a7b983f861ed6a9a541a7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Dispose </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Releases the reader. </p>

</div>
</div>
<a class="anchor" id="ad203b4b412d27790ac1f18e23fdc1444"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> Calibrate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calibrates the reader. </p>
<p>This function calibrates a reader and blocks until the calibration is complete. It can take several seconds to calibrate for some devices. </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: Calibration succeeded; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_DEVICE_BUSY: Another operation is in progress; DPFPDD_E_DEVICE_FAILURE: Failed to calibrate, reader is not functioning properly. </dd></dl>

</div>
</div>
<a class="anchor" id="a9ad7a00fd20da92640c6c7f42f8542ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> GetStatus </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Populates the <a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_status.html" title="Container class describing status of the reader. ">ReaderStatus</a> sub-class. </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: <a class="el" href="class_d_p_uru_net_1_1_reader.html" title="Represents the a physical fingerprint reader. Contains methods to capture and stream an Fid...">Reader</a> status obtained; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; </dd></dl>

</div>
</div>
<a class="anchor" id="afa3ba68bb9799b755351f13f1f223cdc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_constants.html#ad8097859ab1bdd06be52a8421df152d4">Constants.ResultCode</a> Reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resets the reader. </p>
<p>This function performs a hardware reset on the reader. Hardware resets are typically needed only after a hardware problem (e.g., the reader is unplugged or receives an electrostatic shock). This function blocks until the reset is complete. </p>
<dl class="section return"><dt>Returns</dt><dd>DPFPDD_SUCCESS: Reset succeeded; DPFPDD_E_FAILURE: Unexpected failure; DPFPDD_E_INVALID_DEVICE: Invalid reader; DPFPDD_E_DEVICE_BUSY: Another operation is in progress; DPFPDD_E_DEVICE_FAILURE: Failed to reset, reader is not functioning properly. </dd></dl>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a130823283672d817d178c0d145cd9fd9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_description.html">ReaderDescription</a> Description</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Complete information about the reader hardware. </p>

</div>
</div>
<a class="anchor" id="a2336a1c410d5a55d758d10e2479fc15e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_status.html">ReaderStatus</a> Status</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Container class to hold reader status. </p>

</div>
</div>
<a class="anchor" id="a8adc65903ba9b324a4819f62573b0335"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_d_p_uru_net_1_1_reader_1_1_reader_capabilities.html">ReaderCapabilities</a> Capabilities</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Contains information about reader capabilities (i.e., can capture, can stream, ...) </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Work/BiometricSDK/Main/_Root/Source/DotNet/DPUruNet/Reader.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 7 2012 12:27:15 for UareU SDK .Net API by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
