Contents
Previous Topic: ClearHistory Method
Next Topic: ExitRoom Method
| | |
| ||
| ||
EnterRoom Method
Allows the user to enter the specified chat room.
Syntax
object.EnterRoom RoomPath, RoomPwd, ThisParticipantAlias, SecurityPackage, Flags, Type
Parameters
object Required. An object expression that evaluates to a Chat control. RoomPath Required. A string value containing the location of the chat room. The format of the string should be: [prefix]://server-name[:port-number]/[[#]|[&]]room-name
The prefix is optional and can be either mic or irc. The server-name is the host name of the chat server computer. The optional number sign (#) indicates that the chat room can be a global IRC room. The optional ampersand (&) indicates that the room can be a local IRC or MIC room. The room-name is the name of the chat room.
RoomPwd Required. A string containing either the room password or the host key used when creating or joining a password-protected room. ThisParticipantAlias Required. A string containing the alias that the user will be known by in the chat room. SecurityPackage Required. A string containing a list of security packages that are separated by semicolons and ordered by preference. If SecurityPackage is set to an empty string, the control asks the server for a list of security packages it provides. If the server replies no packages at all, an anonymous connection is tried. If the server replies with a list of packages, the first package on the list is tried. If the string is set to "ALL", all the server's security packages are tried in an order defined by the server. The control will stop looping through the security packages as soon as one package succeeds or an error not related to the account information occurs. If all packages fail, the control will try to connect the user anonymously. The "ANON" string can be used to request anonymous connections. Flags Required. A combination of values used when creating or joining a room. These values characterize the room type and cannot change dynamically once the room is created. Set to zero to use no flags. Can be any combination of the following values.
1 Join an existing chat room or create a chat room if one does not exist. If this flag is not set, the EnterRoom method will create a chat, but will not join an existing chat. 2 The chat room will not be exposed to other servers on the Internet. 4 The chat room is set up as read-only for news feeds, stock quotes, and so on. 8 The chat room will allow only MIC clients to join it. IRC users will not be able to join the chat room. 16 The server will accept only authenticated members in this chat room. 32 Only authenticated members can talk in the chat room. Type Required. A combination of values to set the type of chat room. Set to zero to use no flags. The chat room type can dynamically vary during its lifetime. The user is notified when the room type changes through the OnRoomTypeChanged event. Can be any combination of the following values.
1 Allows any user into the chat room. 2 Allows only hosts to change the topic of the chat room. 4 Allows only users who logged on to this server to enter the chat room. 8 Disables whispering in the chat room. 16 Creates an auditorium room. The member list shows only the user and the hosts. Participants cannot whisper, but hosts can whisper to anybody, regardless of whether the no-whisper (Type=8) flag is set. Messages coming from participants are sent only to the hosts. 32 Creates a moderated room. Members join the chat room as spectators by default. Remarks
This method should be called only when the control's State property is equal to 1 (Disconnected).
See Also
Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.