Phantasmal Site > Phantasmal API > API Listing > query_soundex_with_keywords

API Function: query_soundex_with_keywords

Summary:

query the HelpD for a phonetic match

Defined In LPC Object:

/usr/System/sys/helpd.c

Prototype:

mixed *query_soundex_with_keywords(string key, object user)

Can Be Called By:

System, Common, Game

Description:

Check the HelpD for an entry matching 'key' phonetically. The supplied user object is necessary to determine locale, so that various languages can be queried as appropriate. Currently, Phantasmal's HelpD only supports Soundex queries in English. If the help entry is protected by keywords (such as "admin", a favorite) then each keyword it is protected by must be listed in the keywords array passed to this function.

Return Value:

An array of help entries matching the supplied string is returned. See 'query_exact' for the format.

If no entries are found, nil is returned.

Errors:

Normally none

See Also:

new_help_file , query_exact_with_keywords , query_exact , query_soundex