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>IsAutoWhiteBalance</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/camera/Overview.html">camera</a>::<a href="../../../nn/camera/CTR/Overview.html">CTR</a>::IsAutoWhiteBalance</CODE> Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> IsAutoWhiteBalance(
15     bool * pOn,
16     <a href="../../../nn/camera/CTR/CameraSelect.html">CameraSelect</a> select
17);
18</pre>
19    </div>
20    <h2>Parameters</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>out</td>
32          <th>pOn</th>
33<td>Returns <CODE>TRUE</CODE> if enabled, and <CODE>FALSE</CODE> otherwise.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th>select</th>
38          <td>Specifies the camera for which to check settings.</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46            <th>Value</th>
47            <td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51          <th><CODE>Result::IsSuccess</CODE></th>
52          <td>Process was successful.</td>
53        </tr>
54        <tr>
55          <th><CODE>ResultIsSleeping</CODE></th>
56          <td>This function is unusable because the system cover is closed.</td>
57        </tr>
58        <tr>
59          <th><CODE>ResultFatalError</CODE></th>
60          <td>There may be something physically wrong with the camera.</td>
61        </tr>
62      </table> </div>
63    <h2>Description</h2>
64    <div class="section">
65<p>Gets whether automatic white balance is enabled.</p><p><B>Note:</B> This function may block for an extended period if a camera is restarting.</p></div>
66    <h2>Revision History</h2>
67    <div class="section">
68      <dl class="history">
69        <dt>2010/07/17</dt>
70        <dd>Added explanation about operation during restart.
71        </dd>
72        <dt>2010/07/14</dt>
73        <dd>Deleted related text following deletion of <CODE>SynchronizeWhiteBalance</CODE> function.
74        </dd>
75        <dt>2010/06/18</dt>
76        <dd>Added information about this function's relationship with the <CODE>SynchronizeWhiteBalance</CODE> function.<br />
77        </dd>
78        <dt>2010/02/02</dt>
79        <dd>Initial version.<br />
80        </dd>
81      </dl>
82    </div>
83  <hr><p>CONFIDENTIAL</p></body>
84</html>