WoW:API JoinChannelByName: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(possible bad info in my edit, took it back out)
No edit summary
Line 10: Line 10:
:(String channelName, String password, String frameID)
:(String channelName, String password, String frameID)


:;channelName : The name of the channel to leave
:;channelName : The name of the channel to join
:;password : The channel password (optional)
:;password : The channel password (optional)
:;frameID : Some ID number
:;frameID : The frame ID number, ostensibly from a ChatFrame object. Use [[API Frame GetID|Frame:GetID()]] to retrieve it


----
----
;''Returns''
;''Returns''


:;nil
:'''zero''', regardless of success or failure


----
----

Revision as of 22:37, 26 February 2005

JoinChannelByName -Documentation by AlexanderYoshi-

Joins the channel with the specified name.

JoinChannelByName(channelName, password, frameID);

Arguments
(String channelName, String password, String frameID)
channelName
The name of the channel to join
password
The channel password (optional)
frameID
The frame ID number, ostensibly from a ChatFrame object. Use Frame:GetID() to retrieve it

Returns
zero, regardless of success or failure

Example
JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID());
Result

Description
Joins the channel with the specified name if there are less than 10 live channels.

Template:WoW API