enumChannelMode Enumeration


		Contents Index Topic Contents
	Previous Topic: Enumerations Next Topic: enumChannelState Enumeration

enumChannelMode Enumeration

Used in OnChannelProperty and OnChannelPropertyChanged events, CreateChannel, ChangeChannelProperty, and QueryChannelProperty methods, and ChannelProperty property to contain the channel mode.

Value Description

cmNone Value = &H0. No particular mode is set.

cmPublic Value = &H0. The channel is public and all information about the channel (except for text messages) can be queried by nonmembers. The cmPublic mode is mutually exclusive with the cmPrivate, cmHidden, and cmSecret modes.

cmPrivate Value = &H1. The channel is private and only the name, number of members, and PICS rating property can be queried by nonmembers. The cmPrivate mode is mutually exclusive with the cmPublic, cmHidden, and cmSecret modes.

cmHidden Value = &H2. The channel is hidden and cannot be located through enumeration queries by nonmembers. The cmHidden mode is mutually exclusive with the cmPublic, cmPrivate, and cmSecret modes. The purpose of the new cmHidden channel mode is to permit the existence of channels that cannot be found using the standard LIST IRC command, but whose properties can be queried if the exact channel name is known. Thus a hidden channel is like a public channel except that it cannot be enumerated by using a ListChannels method call.

cmSecret Value = &H4. The channel is secret and cannot be located by any query from nonmembers. The cmSecret mode is mutually exclusive with the cmPublic, cmPrivate, and cmHidden modes.

cmModerated Value = &H8. Normally, new channel members may speak. In cmModerated mode, however, by default, new channel members may not speak. This is achieved by designating the no voice mode to all new members for that channel. Although the no voice mode usually has no effect, it does affect a moderated channel.

cmNoExtern Value = &H10. Blocks messages from nonmembers to the channel. An administrator can still send a message to the channel.

cmTopicop Value = &H20. Permits only channel owners and hosts to change the channel topic property.

cmInvite Value = &H40. Permits only invited users to enter the channel. Only owners and hosts can issue an invitation when this mode is on.

cmKnock Value = &H80. The cmKnock extended mode causes an OnKnock event to be fired for owners and hosts of the channel if a user attempts to join a channel and is denied entrance by the server.

cmNoWhisper Value = &H100. Prevents whisper messages from being sent to the channel.

cmRegistered Value = &H200. The channel is registered by the administrator of the chat network. The registration procedure is not defined here and is implementation-dependent. Only the server or administrator can set this mode.

cmService Value = &H400. A service is monitoring/controlling the channel. This is an indication to the client that message traffic sent to the channel is being monitored by a chat service that does not appear as a member in the channel. The cmService flag can be set only by the chat server.

cmAuthOnly Value = &H800. Permits channel access only to users who have been authenticated by the server. Note that an authenticated user is any user who was successfully authenticated by the Password parameter or SecurityPackages parameter during the Login method.

cmCloneable Value = &H1000. Defines a channel that creates new clone channels if the parent channel is full. A clone channel is created with the same name as the parent cloneable channel with a numeric suffix starting at 1 and ranging to 99. It is not valid to set the cmCloneable channel mode of a parent channel that ends with a numeric character. The clone channel inherits modes and properties from the parent channel when it is set up. When a clone channel is created, any channel that has the same name is removed. This prevents channel takeover of a clone channel. It is advised that only administrators be allowed to set cmCloneable mode on a channel.

cmClone Value = &H2000. Defines a channel that was created by the server when a parent cloneable channel becomes full. Users should usually join the parent channel, although a user can join a clone channel that is not full. Only the server can set up a clone channel and set this mode.

cmAuditorium Value = &H4000. Restricts visibility and messaging within a channel. Members will only see themselves and the hosts/owners in the channel. Any message sent by a member will be received only by the hosts and owners. Hosts and owners will see all members in the channel. Messages from a host or owner are seen by all channel members. Ordinary members will not receive OnAddMember and OnDelMember events for other members. This mode is designed for channels with such a large membership that the members do not want to see each other.

cmNoFormat Value = &H8000. Indicates to the client application not to format text received from the channel. Normally, clients will prefix text messages with "x said y" or "x whispers to y and x". If the cmNoFormat mode is set, just the raw text is displayed, wrapping to the next line at the end of the message. The client should not echo text sent by the client. This is to permit custom applications to control the formatting to clients.
Because cmNoFormat is a channel mode and could be abused by the channel host, clients may want to inform users that messages can be spoofed or imitated with this mode. With MIC 2.0, only the administrator can enable this mode on persistent channels. This is the IRCX +f channel mode. The concept does not exist on other IRC servers. Clients can choose to ignore the flag.

cmCreateOnly Value = &H10000000. Only used in a CreateChannel call. If set, the channel is opened only if it does not yet exist.

Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.

Value	Description
cmNone	Value = &H0. No particular mode is set.
cmPublic	Value = &H0. The channel is public and all information about the channel (except for text messages) can be queried by nonmembers. The cmPublic mode is mutually exclusive with the cmPrivate, cmHidden, and cmSecret modes.
cmPrivate	Value = &H1. The channel is private and only the name, number of members, and PICS rating property can be queried by nonmembers. The cmPrivate mode is mutually exclusive with the cmPublic, cmHidden, and cmSecret modes.
cmHidden	Value = &H2. The channel is hidden and cannot be located through enumeration queries by nonmembers. The cmHidden mode is mutually exclusive with the cmPublic, cmPrivate, and cmSecret modes. The purpose of the new cmHidden channel mode is to permit the existence of channels that cannot be found using the standard LIST IRC command, but whose properties can be queried if the exact channel name is known. Thus a hidden channel is like a public channel except that it cannot be enumerated by using a ListChannels method call.
cmSecret	Value = &H4. The channel is secret and cannot be located by any query from nonmembers. The cmSecret mode is mutually exclusive with the cmPublic, cmPrivate, and cmHidden modes.
cmModerated	Value = &H8. Normally, new channel members may speak. In cmModerated mode, however, by default, new channel members may not speak. This is achieved by designating the no voice mode to all new members for that channel. Although the no voice mode usually has no effect, it does affect a moderated channel.
cmNoExtern	Value = &H10. Blocks messages from nonmembers to the channel. An administrator can still send a message to the channel.
cmTopicop	Value = &H20. Permits only channel owners and hosts to change the channel topic property.
cmInvite	Value = &H40. Permits only invited users to enter the channel. Only owners and hosts can issue an invitation when this mode is on.
cmKnock	Value = &H80. The cmKnock extended mode causes an OnKnock event to be fired for owners and hosts of the channel if a user attempts to join a channel and is denied entrance by the server.
cmNoWhisper	Value = &H100. Prevents whisper messages from being sent to the channel.
cmRegistered	Value = &H200. The channel is registered by the administrator of the chat network. The registration procedure is not defined here and is implementation-dependent. Only the server or administrator can set this mode.
cmService	Value = &H400. A service is monitoring/controlling the channel. This is an indication to the client that message traffic sent to the channel is being monitored by a chat service that does not appear as a member in the channel. The cmService flag can be set only by the chat server.
cmAuthOnly	Value = &H800. Permits channel access only to users who have been authenticated by the server. Note that an authenticated user is any user who was successfully authenticated by the Password parameter or SecurityPackages parameter during the Login method.
cmCloneable	Value = &H1000. Defines a channel that creates new clone channels if the parent channel is full. A clone channel is created with the same name as the parent cloneable channel with a numeric suffix starting at 1 and ranging to 99. It is not valid to set the cmCloneable channel mode of a parent channel that ends with a numeric character. The clone channel inherits modes and properties from the parent channel when it is set up. When a clone channel is created, any channel that has the same name is removed. This prevents channel takeover of a clone channel. It is advised that only administrators be allowed to set cmCloneable mode on a channel.
cmClone	Value = &H2000. Defines a channel that was created by the server when a parent cloneable channel becomes full. Users should usually join the parent channel, although a user can join a clone channel that is not full. Only the server can set up a clone channel and set this mode.
cmAuditorium	Value = &H4000. Restricts visibility and messaging within a channel. Members will only see themselves and the hosts/owners in the channel. Any message sent by a member will be received only by the hosts and owners. Hosts and owners will see all members in the channel. Messages from a host or owner are seen by all channel members. Ordinary members will not receive OnAddMember and OnDelMember events for other members. This mode is designed for channels with such a large membership that the members do not want to see each other.
cmNoFormat	Value = &H8000. Indicates to the client application not to format text received from the channel. Normally, clients will prefix text messages with "x said y" or "x whispers to y and x". If the cmNoFormat mode is set, just the raw text is displayed, wrapping to the next line at the end of the message. The client should not echo text sent by the client. This is to permit custom applications to control the formatting to clients. Because cmNoFormat is a channel mode and could be abused by the channel host, clients may want to inform users that messages can be spoofed or imitated with this mode. With MIC 2.0, only the administrator can enable this mode on persistent channels. This is the IRCX +f channel mode. The concept does not exist on other IRC servers. Clients can choose to ignore the flag.
cmCreateOnly	Value = &H10000000. Only used in a CreateChannel call. If set, the channel is opened only if it does not yet exist.