API:TextEditBoxGetMaxChars

UI Lua API · TextEditBox functions
Version: WAR 1.4.8

Returns the maximum number of characters a TextEditBox accepts.

maxChars = TextEditBoxGetMaxChars(editBoxName)

Arguments

editBoxName

string – Name of a TextEditBox window.

Returns

maxChars

number – The current limit, the value that TextEditBoxSetMaxChars sets.

Details

• If the window does not exist or is not a TextEditBox, the error is logged and nothing is returned.
• The function needs at least one argument and only reads the last one.
• The stock UI never calls TextEditBoxGetMaxChars.

Errors

These are written to the UI log; the call returns normally.

• Error in function call 'TextEditBoxGetMaxChars': Window %s does not exist
• Error in function call 'TextEditBoxGetMaxChars': Window %s is not a TextEditBox

Example

A minimal example built from the signature above:

local limit = TextEditBoxGetMaxChars( "MyEditBox" )

See also

• TextEditBoxSetMaxChars
• TextEditBoxGetText