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>SetMaskMode</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/ngc/Overview.html">ngc</a>::<a href="../../../../nn/ngc/CTR/Overview.html">CTR</a>::<a href="../../../../nn/ngc/CTR/ProfanityFilter/Overview.html">ProfanityFilter</a>::SetMaskMode</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14void SetMaskMode(
15     bool bOverWrite
16);
17</pre>
18    </div>
19<h2>Parameters</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th><CODE>bOverWrite</CODE></th>
32<td>Specify <CODE>true</CODE> (the default setting) to overwrite the entire text with asterisk symbols when profanity is discovered. Specify <CODE>false</CODE> to substitute a single asterisk symbol for any discovered profanity word.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36    <div class="section">
37None.
38               </div>
39<h2>Description</h2>
40    <div class="section">
41<p>Sets how to behave when text is checked and profanity is discovered.</p><p>In the default mode, the entire text is overwritten with asterisk symbols when profanity is discovered. In some cases, this can result in display of text outside of the area of the box on the screen. For example, the asterisk symbol &quot;*&quot; is wider than the letter &quot;i&quot; when a proportional font is being used, so when overwriting the text with asterisk symbols there is a risk that the result will extend beyond the screen.</p><p>By specifying <CODE>false</CODE> for this function, when a profanity word is discovered only one asterisk symbol is displayed in substitution for that word, and as a result there is no danger to the integrity of the user interface.</p><p>This setting is only enabled when text is checked by the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilter/MaskProfanityWordsInText.html">ProfanityFilter::MaskProfanityWordsInText</a></CODE> function. It has no effect on behavior when words are being checked by the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilter/CheckProfanityWords.html">ProfanityFilter::CheckProfanityWords</a></CODE> function.</p><p>The specified setting is reset to the default state (<CODE>true</CODE>) when the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilter/Finalize.html">ProfanityFilter::Finalize</a></CODE> function is called.</p><!-- write here --></div>
42<h2>Revision History</h2>
43    <div class="section">
44      <dl class="history">
45        <dt>2011/12/16</dt>
46<dd>Initial version.<br />
47        </dd>
48      </dl>
49    </div>
50  <hr><p>CONFIDENTIAL</p></body>
51</html>