Text::GetWhitespaceLength

Defined in: C4String.h

Returns the number of whitespace characters at the beginning of a character string.

Prototype

int32 GetWhitespaceLength(const char *text);

Parameters

text A pointer to a character string.

Description

The GetWhitespaceLength function returns the number of whitespace characters at the beginning of the character string specified by the text parameter.

Any characters having an ASCII value between 1 and 32, inclusive, is considered whitespace by this function. Also, if this function encounters two consecutive forward slashes, then it treats all of the characters between the slashes and the end of the line on which they appear as part of a comment, which is considered whitespace.