1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>Initialize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/y2r/Overview.html">y2r</a>::<a href="../../../nn/y2r/CTR/Overview.html">CTR</a>::Initialize</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool Initialize();
15</pre>
16    </div>
17<h2>Parameters</h2>
18    <div class="section">
19<p>None.</p>
20    </div>
21<h2>Return Values</h2>
22<div class="section">Returns <CODE>true</CODE> on success; otherwise, returns <CODE>false</CODE> on failure due to being in use by another process. </div>
23<h2>Description</h2>
24    <div class="section">
25<p>Initializes the Y2R library.</p><p>You must call this function before calling any of the functions in the <CODE><a href="../../../nn/y2r/CTR/Overview.html">nn::y2r::CTR</a></CODE> namespace.<br /></p><p>
26This function may return FALSE for a short while, immediately after the <a href="../../../nn/y2r/CTR/Finalize.html"><CODE>nn::y2r::CTR::Finalize</CODE></a> function is called. If this happens, insert a small wait time of about 1 millisecond, and call this function again.
27            </p></div>
28<h2>Revision History</h2>
29    <div class="section">
30      <dl class="history">
31        <dt>2012/01/23</dt>
32<dd>Added the fact that this function may return <CODE>false</CODE> for a short time after the <a href="../../../nn/y2r/CTR/Finalize.html">nn::y2r::CTR::Finalize</a> function has been called.
33        </dd>
34        <dt>2011/12/19</dt>
35<dd>Noted that <CODE>false</CODE> is not returned as a return value.<br />
36        </dd>
37        <dt>2011/01/14</dt>
38<dd>Added explanation that the function can return <CODE>false</CODE>.
39        </dd>
40        <dt>2010/01/07</dt>
41<dd>Initial version.<br />
42        </dd>
43      </dl>
44    </div>
45  <hr><p>CONFIDENTIAL</p></body>
46</html>