Phantasmal Site > Phantasmal API > API Listing > trim_whitespace

API Function: trim_whitespace

Summary:

trim leading and trailing whitespace from the Phrase

Defined In LPC Object:

/usr/common/lib/intl_phrase.c

Prototype:

void trim_whitespace(void)

Can Be Called By:

Anybody

Description:

Modifies the Phrase to remove leading and trailing whitespace in all supported locales. This is equivalent to the StringD's trim_whitespace function for most simple phrases. One difference is that this version modifies the Phrase in-place and returns nothing.

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:

to_string , stringd:trim_whitespace