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><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>::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 <a href="../../../../nn_types/bit32.html">bit32</a> * pCheckResults, 16 const wchar_t ** ppWords, 17 size_t nWordCount 18); 19 20virtual <a href="../../../../nn/Result/Overview.html">nn::Result</a> CheckProfanityWords( 21 <a href="../../../../nn_types/bit32.html">bit32</a> * pCheckResults, 22 <a href="../../../../nn/ngc/CTR/ProfanityFilterPatternList.html">ProfanityFilterPatternList</a> nPatternCode, 23 const wchar_t ** ppWords, 24 size_t nWordCount 25); 26 27virtual <a href="../../../../nn/Result/Overview.html">nn::Result</a> CheckProfanityWords( 28 <a href="../../../../nn_types/bit32.html">bit32</a> * pCheckResults, 29 bool bCommunicateWithOtherRegions, 30 const wchar_t ** ppWords, 31 size_t nWordCount 32); 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>Checks a number of specified words against all pattern lists to determine if strings contain profanity and should not be displayed.</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>Checks a number of specified words against the specified pattern lists to determine if strings contain profanity and should not be displayed.</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>Checks a number of specified words to determine if strings contain profanity and should not be displayed. 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 function checks single words, such as screen names. The maximum number of characters (including the null terminator) per word is <CODE> <a href="../../../../nn/ngc/MAX_WORD_LENGTH.html">nn::ngc::MAX_WORD_LENGTH</a></CODE>. It cannot be used to process text input by the user. To check text input, use the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilter/MaskProfanityWordsInText.html">ProfanityFilter::MaskProfanityWordsInText</a></CODE> function instead.</p><p>This operation occasionally takes a long time. (It blocks while in progress.) Processing time may differ depending on the version of the system installed. Nintendo recommends running this function in a separate thread, as running it in the main thread can cause the frame rate to decrease. This function can be used to check a maximum of <CODE><a href="../../../../nn/ngc/MAX_WORD_NUM.html">nn::ngc::MAX_WORD_NUM</a></CODE> 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 value of the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilterPatternList.html">nn::ngc::CTR::ProfanityFilterPatternList</a></CODE> enumerated type constant. The bit field has a value of <CODE>0</CODE> if no strings are registered as profanity in any pattern lists.</p><p>See the most recent UGC guidelines for details on the pattern lists that text must be checked against.</p><p>If the string includes the @ symbol (which might denote an e-mail address), the function always detects this as a possible problematic word. However, strings that contain multiple numbers (which might be used in the display of phone numbers), are not detected as problematic words. For this check, use the <CODE><a href="../../../../nn/ngc/CTR/CountNumbers.html">nn::ngc::CTR::CountNumbers</a></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 function checks single words, such as screen names. The maximum number of characters (including the null terminator) per word is <CODE> <a href="../../../../nn/ngc/MAX_WORD_LENGTH.html">nn::ngc::MAX_WORD_LENGTH</a></CODE>. It cannot be used to process text input by the user. To check text input, use the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilter/MaskProfanityWordsInText.html">ProfanityFilter::MaskProfanityWordsInText</a></CODE> function instead.</p><p>This operation occasionally takes a long time. (It blocks while in progress.) Processing time may differ depending on the version of the system installed. Nintendo recommends running this function in a separate thread, as running it in the main thread can cause the frame rate to decrease. This function can be used to check a maximum of <CODE><a href="../../../../nn/ngc/MAX_WORD_NUM.html">nn::ngc::MAX_WORD_NUM</a></CODE> 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 by taking the bitwise AND of this and the result of left-shifting the value <CODE>1</CODE> 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 the pattern lists that text must be checked against.</p><p>If the string includes the @ symbol (which might denote an e-mail address), the function always detects this as a possible problematic word. However, strings that contain multiple numbers (which might be used in the display of phone numbers), are not detected as problematic words. For this check, use the <CODE><a href="../../../../nn/ngc/CTR/CountNumbers.html">nn::ngc::CTR::CountNumbers</a></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 function checks single words, such as screen names. The maximum number of characters (including the null terminator) per word is <CODE> <a href="../../../../nn/ngc/MAX_WORD_LENGTH.html">nn::ngc::MAX_WORD_LENGTH</a></CODE>. It cannot be used to process text input by the user. To check text input, use the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilter/MaskProfanityWordsInText.html">ProfanityFilter::MaskProfanityWordsInText</a></CODE> function instead.</p><p>This operation occasionally takes a long time. (It blocks while in progress.) Processing time may differ depending on the version of the system installed. Nintendo recommends running this function in a separate thread, as running it in the main thread can cause the frame rate to decrease. This function can be used to check a maximum of <CODE><a href="../../../../nn/ngc/MAX_WORD_NUM.html">nn::ngc::MAX_WORD_NUM</a></CODE> 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><a href="../../../../nn/cfg/Overview.html">cfg</a></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 value of the <CODE><a href="../../../../nn/ngc/CTR/ProfanityFilterPatternList.html">nn::ngc::CTR::ProfanityFilterPatternList</a></CODE> enumerated type constant. 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 (which might denote an e-mail address), the function always detects this as a possible problematic word. However, strings that contain multiple numbers (which might be used in the display of phone numbers), are not detected as problematic words. For this check, use the <CODE><a href="../../../../nn/ngc/CTR/CountNumbers.html">nn::ngc::CTR::CountNumbers</a></CODE> function.</p></div> 63 <hr><p>CONFIDENTIAL</p></body> 64</html>