DWC_CheckProfanityAsync

Syntax

#include <dwc.h>

BOOL DWC_CheckProfanityAsync(const u16 **words,
                             int wordsnum,
                             const char *reserved,
                             int timeout,
                             char *result,
                             int *badwordsnum);

Arguments

words	Pointer to the string array to be checked. Use Unicode (big-endian UTF16) for the character code. If you are using a different character code, be sure to convert to Unicode. If the screen name contains a special character not found in Unicode or the IPL font, replace it with a space. The terminal character must be "" ("0x0000" in u16). The total of all strings within the array must be no greater than 501 characters (including the terminal characters of each string).
wordsnum	The number of elements in the string array specified by words (1-50).
reserved	Specify NULL.
timeout	The server response timeout interval (in milliseconds). (If 0 or less is specified, the default value of 10000 will be used.)
result	A pointer to the location that stores the results of the check (requires an area of `wordsnum` bytes).
badwordsnum	A pointer to the location that stores the number of illegal strings contained in the results of the check.

Return Values

TRUE	The check for illegal strings has started.
FALSE	The check for illegal strings failed to start.

Description

Starts the check for illegal strings. It always returns FALSE if called while an illegal string check is in progress.

The illegal string check is performed by communicating with the authentication server. The process is similar to that of the DWC_LoginAsync function in the way it checks contents. It is also similar in that the check is done by the word. In addition to being able to check for individual illegal strings, this function can check multiple strings at once within the following limits:

It can check up to 50 strings at once.
The total length of all the strings, including the terminal characters of each string, can be up to 501 characters.

After calling this function, proceed to check for illegal strings by calling the DWC_CheckProfanityProcess function approximately every game frame. When the illegal string check completes successfully, the results of the check will be stored as an array.

If one of the strings given to words for checking is illegal, the result of the check stored in result will contain 1. Otherwise, the result will contain 0. These results are stored in the same order as the checked strings.

[Example]

words[4]={L"goodoword1",L"goodoword2",L"badword",L"goodoword3"}

If in the above group of strings only the third index ("badword") is an illegal string, the following will result:

result[4]={0,0,1,0} badwordsnum=1

This function calls the NHTTPStartup function internally. Avoid the overlapping use of NHTTP before and after the interval between the time this function is called and the illegal string check is performed.

Revision History

1.4.12: Added information specific to conflicts in NHTTP.
1.4.6: Corrected error: "If 0 is specified" was changed to "If 0 or less is specified".
1.4.1: Initial version.