Channel Object

INmChannel::EnumMember

HRESULT EnumMember(
    [out] IEnumNmMember **ppEnum);

Retrieves an instance of the enumerator for Member objects in this channel. The IEnumNmMember Interface methods can be used to manipulate this enumerator.

Returns one of the following values:

S_OK Success.
E_POINTER The ppEnum pointer is invalid.
E_FAIL Internal resources are not available.
E_OUTOFMEMORY Memory could not be allocated to service the request.

ppEnum: Pointer to a pointer to a member enumerator.

INmChannel::GetConference

HRESULT GetConference(
    [out] INmConference **ppConference);

Retrieves the Conference object to which the channel belongs.

Returns one of the following values:

S_OK Success.
E_POINTER The ppConference pointer is invalid.
E_FAIL An internal resource is not available.

ppConference: Pointer to a pointer to the INmConference Interface on the Conference object to which this channel belongs.

If this method returns S_OK, the application must call Release for the conference interface returned in ppConference.

INmChannel::GetInterface

HRESULT GetInterface(
    [out] IID *piid);

Obtains the channel-specific interface identifier.

Returns S_OK if successful, or E_POINTER if the piid pointer is invalid.

piid: Pointer to a buffer to receive the channel-specific interface identifier.

INmChannel::GetMemberCount

HRESULT GetMemberCount(
    [out] ULONG * puCount);

Retrieves the current number of members in the channel.

Returns one of the following values:

S_OK Success.
E_POINTER The puCount pointer is invalid.
E_FAIL Internal resources are not available.

puCount: Pointer to a ULONG containing the number of members.

INmChannel::GetNmch

HRESULT GetNmch(
    [out] ULONG *puCh);

Retrieves the channel type.

Returns S_OK if successful, or E_POINTER if the puCh pointer is invalid.

puCh

Pointer to a ULONG that identifies the channel type. This can be one of the following:

NMCH_AUDIO	Audio channel.
NMCH_DATA	Data channel.
NMCH_FT	File Transfer channel.
NMCH_SHARE	Application Sharing channel.
NMCH_VIDEO	Video channel.

INmChannel::IsActive

HRESULT IsActive(void);

Determines if the channel is active.

Returns S_OK if the channel is active, or S_FALSE if it is not.

If a channel is inactive, it is not currently transmitting information.

The behavior of an active channel depends on the specific channel type.

The INmChannel::SetActive method can be used to change this state for some channels.

INmChannel::IsSameAs

HRESULT IsSameAs(
    [in] INmChannel *pChannel);

Indicates whether two Channel objects represent the same channel.

Returns one of the following values:

S_OK Both Channel objects represent the same channel.
S_FALSE The two Channel objects do not represent the same channel.
E_POINTER The pChannel pointer is invalid.

pChannel: Pointer to the object to be compared to this Channel object.

INmChannel::SetActive

HRESULT SetActive(
    [in] BOOL fActive);

Sets the channel to active or inactive.

Returns S_OK if successful.

fActive: BOOL value that is TRUE to activate the channel or FALSE to deactivate it.

This method can only be used with the audio and video channels.

Applications must deactiveate all current audio channels before activating a new audio channel.

INmChannelNotify Interface

This is an event notification sink interface for the INmChannel interface. The methods in this interface are called by the Channel object when specific events occur.

These event sink methods should be defined and implemented by the client application to respond to notifications from a Channel object. For example, the INmChannelNotify::MemberChanged method is notified when a member of the channel is added, removed, or updated. The client application implementation of this method could provide a display to the user informing him or her of the addition, removal, or update of the specific member.

MemberChanged
NmUI

Back to INmChannelNotify Interface

INmChannelNotify::MemberChanged

HRESULT MemberChanged(
    [in] NM_MEMBER_NOTIFY uNotify,
    [in] INmMember *pMember);

Receives notification that a member of the channel was added, removed, or updated.

This event sink should always return S_OK to the event source.

uNotify

Identifier of an event constant during a conference. This can include the following values:

NM_MEMBER_ADDED	A member was added to the conference.
NM_MEMBER_REMOVED	A member was removed from the conference.
NM_MEMBER_UPDATED	Information for a conference member was updated.

pMember

Pointer to the INmMember Interface on the Member object that changed.

Back to INmChannelNotify Interface

INmChannelNotify::NmUI

HRESULT NmUI(
    [in] CONFN uNotify);

Receives event notification when a channel change occurs. Only the application in charge (initialized with NM_INIT_CONTROL) of the NetMeeting user interface will receive these notifications.

This event sink should always return S_OK to the event source.

uNotify: Reserved for future use.

This method will receive notifications only if the application succeeded in initializing with puOptions set to NM_INIT_CONTROL.