Phantasmal Site > Phantasmal API > API Listing > get_content_by_lang

API Function: get_content_by_lang

Summary:

return the Phrase rendered as a specific locale

Defined In LPC Object:

/usr/common/lib/intl_phrase.c

Prototype:

string get_content_by_lang(int locale)

Can Be Called By:

Anybody

Description:

Return a string in a specified language. This is useful for simple international phrases, but may fail or return garbage if a Phrase contains ANSI color codes, terminal operations or other things that depend on user information other than language.

Locales are defined in <phrase.h> and the PhraseD.

This function isn't access-protected. You should access-protect your version of this and all other inherited functions, including upgraded() and destructed().

Return Value:

Nothing.

Errors:

Undefined locale or other setting can cause an error, as can access violations.

See Also:

set_content_by_lang , to_string , PhraseD:language_by_name