WoW:API JoinChannelByName: Difference between revisions

Revision as of 08:06, 7 April 2005

JoinChannelByName - Documentation by AlexanderYoshi

Joins the channel with the specified name.

retCode = JoinChannelByName("channelName" [,"password" [,frameID]])

Parameters

Arguments

("channelName" [,"password" [,frameID]])

channelName: String - The name of the channel to join
password: String (optional) - The channel password, nil if none.
frameID: Number (optional) - The chat frame ID number to add the channel to. Use Frame:GetID() to retrieve it for chat frame objects.

Returns

retCode

retCode: Number - Appears to always equal 0.

Example

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

Details

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

Template:WoW API

@@ Line 1: / Line 1: @@
- <center>'''JoinChannelByName''' ''-Documentation by AlexanderYoshi-''</center>
+<center>'''JoinChannelByName''' - ''Documentation by AlexanderYoshi''</center>
 Joins the channel with the specified name.
-  JoinChannelByName(channelName, password, frameID);
+  retCode = JoinChannelByName("channelName" [,"password" [,frameID]])
+== Parameters ==
+=== Arguments ===
+:("channelName" [,"password" [,frameID]])
-----
+:;channelName : String - The name of the channel to join
-;''Arguments''
+:;password : String <small><i>(optional)</i></small> - The channel password, nil if none.
+:;frameID : Number <small><i>(optional)</i></small> - The chat frame ID number to add the channel to. Use [[API Frame GetID|Frame:GetID()]] to retrieve it for chat frame objects.
-:(String channelName, String password, String frameID)
+=== Returns ===
+:retCode
-:;channelName : The name of the channel to join
+:;retCode : Number - Appears to always equal 0.
-:;password : The channel password (optional)
+== Example ==
-:;frameID : The frame ID number, ostensibly from a ChatFrame object. Use [[API Frame GetID|Frame:GetID()]] to retrieve it
+<!-- begin code -->
-----
-;''Returns''
-:'''zero''', regardless of success or failure
-----
-;''Example''
   JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID());
+<!-- end code -->
-;''Result''
+== Details ==
-----
-;''Description''
 : Joins the channel with the specified name if there are less than 10 live channels.
 ----
+__NOTOC__
 {{Template:WoW API}}
+[[Category:API Chat Functions|JoinChannelByName]]

Navigation menu

Search