View source for API:ButtonGetText

{{LuaApi|group=Button}}
Returns the text shown on a Button.

<pre>
text = ButtonGetText(buttonName)
</pre>

== Arguments ==
;buttonName : <code>string</code> – Name of a Button window.

== Returns ==
;text : <code>wstring</code> – The button's text, or <code>L""</code> if the button has no text label.

== Details ==
* The text is copied into a buffer of 256 wide characters before it is returned, so at most the first 255 characters come back.
* Like [[API:LabelGetText|LabelGetText]], it returns the text as displayed, which may differ from the string passed to [[API:ButtonSetText|ButtonSetText]].

== Errors ==
* <code>Error in function call 'ButtonGetText': Window %s does not exist</code>
* <code>Error in function call 'ButtonGetText': Window %s is not a Button</code>

== Example ==
Copying a chat tab's name into the rename box, from <code>ea_chatwindow/source/chatwindow.lua</code>:
<pre>
TextEditBoxSetText( "ChatWindowRenameWindowText", ButtonGetText( tabButtonName ) )
</pre>

Comparing a button's caption, from <code>ea_guildwindow/source/guildwindowtabadmin.lua</code>:
<pre>
if ButtonGetText("GWAdminCommandAddRemoveTitleButton") == GetGuildString(StringTables.Guild.BUTTON_GUILD_ADMIN_COMMAND_ADD_TITLE) then
</pre>

== See also ==
* [[API:ButtonSetText|ButtonSetText]]
* [[API:ButtonGetTextDimensions|ButtonGetTextDimensions]]
* [[API:LabelGetText|LabelGetText]]