Contents
Previous Topic: Properties
Next Topic: ChannelProperty Property
| | |
| ||
| ||
ChannelName Property
Synchronously reads or writes the Name of the channel.
Syntax
value=object.ChannelName
Parameters
value Required. A string containing the Name of the channel. object Required. An object expression that evaluates to a Channel object. Remarks
Access is read/write or read-only depending on the ChannelState value:
- If the ChannelState is chsClosed, the property is read/write.
- If the ChannelState is chsOpening or chsOpen, the property is read-only.
- If the ChannelName property is set while the channel is closed, the CreateChannel and JoinChannel methods use its value if their ChannelName parameter is not specified.
After joining a channel, the ChannelName property is not necessarily the string you specified in CreateChannel, JoinChannel, or ChannelName because of the cloned channels.
For example, you could call:
MsChatPr1.Channels(1).JoinChannel "#Chat"and, in fact, join "#Chat3", which will be the value returned by the ChannelName property.
The ChannelName property is not cleared when the user leaves the channel and the ChannelState becomes chsClosed.
The user can also synchronously get the channel Name using:
<channel>.ChannelProperty("Name")But the ChannelName property is simpler and more efficient.
The asynchronous method of accessing the channel Name is:
<channel>.QueryChannelProperty "Name"See Also
CreateChannel, ChannelProperty, JoinChannel, QueryChannelProperty
Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.