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>CheckProfanityWords</title>
8  </head>
9  <body>
10<h1><CODE>nn::ngc::CTR::ProfanityFilterBase::CheckProfanityWords</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14virtual <a href="../../../../nn/Result/Overview.html">nn::Result</a> CheckProfanityWords(
15     bit32 * pCheckResults,
16     const wchar_t ** ppWords,
17     size_t nWordCount
18) = 0;
19
20virtual <a href="../../../../nn/Result/Overview.html">nn::Result</a> CheckProfanityWords(
21     bit32 * pCheckResults,
22     <a href="../../../../nn/ngc/CTR/ProfanityFilterPatternList.html">ProfanityFilterPatternList</a> nPatternCode,
23     const wchar_t ** ppWords,
24     size_t nWordCount
25) = 0;
26
27virtual <a href="../../../../nn/Result/Overview.html">nn::Result</a> CheckProfanityWords(
28     bit32 * pCheckResults,
29     bool bCommunicateWithOtherRegions,
30     const wchar_t ** ppWords,
31     size_t nWordCount
32) = 0;
33</pre>
34    </div>
35<h2>List of Overloaded Member Functions</h2>
36    <div class="section">
37      <table class="members">
38        <tr>
39          <td>
40<a href="./CheckProfanityWords(0).html"><CODE>CheckProfanityWords ( bit32 *, const wchar_t **, size_t )</CODE> </a>
41          </td>
42<td>Compares the specified strings against all pattern lists to determine if they contain any suspect words.</td>
43        </tr>
44        <tr>
45          <td>
46<a href="./CheckProfanityWords(1).html"><CODE>CheckProfanityWords(bit32 *, ProfanityFilterPatternList, const wchar_t **, size_t)</CODE> </a>
47          </td>
48<td>Compares the specified strings against the specified pattern list to determine if they contain any suspect words.</td>
49        </tr>
50        <tr>
51          <td>
52<a href="./CheckProfanityWords(2).html"><CODE>CheckProfanityWords(bit32 *, bool, const wchar_t **, size_t)</CODE> </a>
53          </td>
54<td>This function confirms whether multiple specified strings are strings that are problematic to display onscreen. It does this by first getting the system region and language settings, then checking against the pattern list specified for that region and language in the UGC Guidelines.</td>
55        </tr> </table>
56    </div>
57<h2>Description of <CODE>CheckProfanityWords(bit32 *, const wchar_t **, size_t)</CODE></h2>
58<div class="section"><p>This operation occasionally takes a long time (it blocks while in progress). This should be run in a separate thread to prevent interference with the game frame process. This function can be used to check multiple strings at once. Checking multiple strings at the same time requires less time than it would to check each string separately.</p><p>The results of the check on each string are stored in the <SPAN class="argument">pCheckResults</SPAN> array. This is structured as a bit field, so you can locate which pattern set contains a problematic string. Check the results by calculating the bitwise AND of (1) this bit field and (2) the result of left-shifting the value <CODE>1</CODE> by the number of bits defined by the value of the <CODE>ProfanityFilterPatternList</CODE> enumerated type. The bit field has a value of <CODE>0</CODE> if no strings registered as profanity in any pattern lists.</p><p>See the most recent UGC guidelines for details on which pattern lists must be checked against.</p><p>If the string includes the @ symbol, the function always detects this as a possible problematic word, even though the symbol might be there because the string denotes an e-mail address. However, since they might be used to display phone numbers, etc., strings that contain multiple numbers are not detected as problematic words. For this check, use the <CODE>nnngc::CTR::CountNumbers</CODE> function.</p></div>
59<h2>Description of <CODE>CheckProfanityWords(bit32 *, ProfanityFilterPatternList, const wchar_t **, size_t)</CODE></h2>
60<div class="section"><p>This operation occasionally takes a long time (it blocks while in progress). This should be run in a separate thread to prevent interference with the game frame process. This function can be used to check multiple strings at once. Checking multiple strings at the same time requires less time than it would to check each string separately.</p><p>The results of the check on each string are stored in the <SPAN class="argument">pCheckResults</SPAN> array. Check the results by taking the bitwise AND of a result and the value 1 shifted left by the value specified in <SPAN class="argument">nPatternCode</SPAN>. The bit field has a value of 0 if there are no profanity patterns specified in any pattern lists.</p><p>See the most recent UGC guidelines for details on which pattern lists must be checked against.</p><p>If the string includes the @ symbol, the function always detects this as a possible problematic word, even though the symbol might be there because the string denotes an e-mail address. However, since they might be used to display phone numbers, etc., strings that contain multiple numbers are not detected as problematic words. For this check, use the <CODE>nnngc::CTR::CountNumbers</CODE> function.</p></div>
61<h2>Description of <CODE>CheckProfanityWords(bit32 *, bool, const wchar_t **, size_t)</CODE></h2>
62<div class="section"><p>This operation occasionally takes a long time (it blocks while in progress). This should be run in a separate thread to prevent interference with the game frame process. This function can be used to check multiple strings at once. Checking multiple strings at the same time requires less time than it would to check each string separately.</p><p>The <CODE>cfg</CODE> library must be initialized to use this function. When this function runs, it references the hardware's region and language settings and, based on that information, automatically selects which pattern list is required and conducts the check for suspect words.</p><p>The results of the check on each string are stored in the <SPAN class="argument">pCheckResults</SPAN> array. This is structured as a bit field, so you can locate which pattern set contains a problematic string. Check the results by calculating the bitwise AND of (1) this bit field and (2) the result of left-shifting the value <CODE>1</CODE> by the number of bits defined by the value of the <CODE>ProfanityFilterPatternList</CODE> enumerated type. The bit field has a value of <CODE>0</CODE> if no strings registered as profanity in any pattern lists.</p><p>If the string includes the @ symbol, the function always detects this as a possible problematic word, even though the symbol might be there because the string denotes an e-mail address. However, since they might be used to display phone numbers, etc., strings that contain multiple numbers are not detected as problematic words. For this check, use the <CODE>nnngc::CTR::CountNumbers</CODE> function.</p></div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>