Conference Object

IConferenceX Properties

This section describes the properties for the IConferenceX interface.

IConferenceX::Name

HRESULT Name(
    BSTR *pbstrName);

Indicates a conference name string. The conference name is the name passed in when the object is created by CreateConference, or is the name that exists when another user's conference is joined.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pbstrName: Address to receive a string for the conference name.

IConferenceX::Capabilities

HRESULT Capabilities(
    LONG *plConfCaps);

Indicates which types of conferences (audio, data, video) the conference was originally created with.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

plConfCaps: Address of a buffer that contains the capabilities of the conference.

IConferenceX::State

HRESULT State(
    LONG *plConfState);

Indicates the state of the conference.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

plConfState

Address to receive a conference state. Can receive one of the following values:

CNF_STATE_ACTIVE	The conference is active and can be used.
CNF_STATE_IDLE	The conference is idle (just created).
CNF_STATE_INITIALIZING	The conference is being initialized.
CNF_STATE_OFFERED	The conference is offered.
CNF_STATE_STOPPING	The conference is being terminated.

IConferenceX::Members

HRESULT Members(
    IConfMembers **ppMembers);

Indicates a collection of existing Member objects when a conference is active.

Returns one of the following values:

S_OK Success. The requested number of elements was returned.
E_OUTOFMEMORY Memory could not be allocated to service the request.
E_UNEXPECTED An unknown error occurred.

ppMembers: Address of a collection of Member objects.

IConferenceX::Applications

HRESULT Applications(
    IConfApplications **ppApplications);

Indicates a collection of Client Application objects available to this conference.

Returns one of the following values:

S_OK Success. The requested number of elements was returned.
E_OUTOFMEMORY Memory could not be allocated to service the request.
E_UNEXPECTED An unknown error occurred.

ppApplications: Address of a collection of Client Application objects.

IConferenceX::ChannelInterfaces

HRESULT ChannelInterfaces(
    IChanInterfaces **ppChanInterfaces);

Indicates a collection of Channel interfaces available to the conference. The interfaces signify how the channel can be used.

Returns one of the following values:

S_OK Success. The requested number of elements was returned.
E_OUTOFMEMORY Memory could not be allocated to service the request.
E_UNEXPECTED An unknown error occurred.

ppChanInterfaces: Address to a collection of Channel interfaces.

IConferenceX::Channels

HRESULT Channels(
    IConfChannels **ppChannels);

Indicates a collection of Channel objects available to the conference.

Returns one of the following values:

S_OK Success. The requested number of elements was returned.
E_OUTOFMEMORY Memory could not be allocated to service the request.
E_UNEXPECTED An unknown error occurred.

ppChannels: Address of a collection of Channel objects.

IConferenceX Methods

This section describes the methods for the IConferenceX interface.

IConferenceX::Invite

HRESULT Invite(
    IConfUserX *pUser,
    BOOLEAN *pfSucceeded);

Invites a new user to the conference. If the conference is inactive, it becomes active when the invited user accepts the invitation.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pUser: Instance of the User object.
pfSucceeded: TRUE if the invitation is accepted, or FALSE otherwise.

This method is asynchronous (an event notification will be returned later if the invitee accepts).

IConferenceX::AcceptInvite

HRESULT AcceptInvite(
    BOOLEAN *pfSucceeded);

Accepts an invitation to a conference.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pfSucceeded: TRUE if the invitation is accepted, or FALSE otherwise.

This method will not be implemented for the first release because the underlying Win32® APIs do not support it. For the first release, invitations will have to be accepted from Microsoft® NetMeeting™.

IConferenceX::RejectInvite

HRESULT RejectInvite(
    BOOLEAN *pfSucceeded);

Rejects an invitation to a conference.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pfSucceeded: TRUE if the user who rejects the invitation is not added to the conference, or FALSE otherwise.

This method will not be implemented for the first release because the underlying Win32 APIs do not support it. For the first release, invitations will have to be rejected from Microsoft NetMeeting.

IConferenceX::Join

HRESULT Join(
    IConfUserX *pUser,
    BOOLEAN *pfSucceeded);

Joins a user who already has a conference running.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pUser: Instance of the User object.
pfSucceeded: TRUE if the join is successful, or FALSE otherwise.

IConferenceX::AcceptJoin

HRESULT AcceptJoin(
    IConfUserX *pUser,
    BOOLEAN *pfSucceeded);

Accepts a request from a user to join a conference.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pUser: Instance of the User object.
pfSucceeded: TRUE if the join is successful, or FALSE otherwise.

This method will not be implemented for the first release because the underlying Win32 APIs do not support it. For the first release, joining will have to be accepted from Microsoft NetMeeting.

IConferenceX::RejectJoin

HRESULT RejectJoin(
    IConfUserX *pUser,
    BOOLEAN *pfSucceeded);

Rejects a request from a user to join a conference.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.

pUser: Instance of the User object.
pfSucceeded: TRUE if the user is not added to the conference, or FALSE otherwise.

This method will not be implemented for the first release because the underlying Win32 APIs do not support it. For the first release, joining will have to be rejected from Microsoft NetMeeting.

IConferenceX::CreateChannel

HRESULT CreateChannel(
    BSTR bstrID,
    IConfChannelX **ppChannel);

Returns an instance of a new Channel object with the specified interface.

Returns one of the following values:

S_OK Success. The requested number of elements was returned.
E_OUTOFMEMORY Memory could not be allocated to service the request.
E_UNEXPECTED An unknown error occurred.

bstrID: Interface ID of the specific-type channel (textual representation of a GUID).
ppChannel: Address to receive an instance of a new Channel object.

This method is not supported in the current version.

IConferenceX::Leave

HRESULT Leave(
    BOOLEAN *pfSucceeded);

Removes the local computer from the active conference.

Returns S_OK if the requested number of elements was returned, or S_FALSE if an unknown error occurred.

pfSucceeded: Request to leave the conference was accepted.

IConferenceX::IsSameAs

HRESULT IsSameAs(
    IConferenceX *pConference,
    BOOLEAN *pfSame);

Identifies whether the two Conference objects represent the same conference.

Returns S_OK if both Conference objects represent the same conference, or S_FALSE if not.

pConference: Instance of the Conference object to compare with.
pfSame: TRUE if it is the same conference, or FALSE otherwise.

IConferenceX::Advise

HRESULT Advise(void);

Enables advisements (events) for the IConferenceX interface.

Returns S_OK if both Conference objects represent the same conference, or E_UNEXPECTED if an unknown error occurred.

IConferenceX::Unadvise

HRESULT Unadvise(void);

Disables advisements (events) for the IConferenceX interface.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if an unknown error occurred.