Conference Manager Object

IConferenceManagerX Properties

This section describes the properties for the IConferenceManagerX interface.

IConferenceManagerX::ConferenceCapabilities

HRESULT ConferenceCapabilities(
    LONG *plConfCaps);

Indicates which types of conferences (audio, data, or video) are available on the local computer.

Returns S_OK if the requested number of elements was returned, or E_UNEXPECTED if the Conference Manager object was not initialized.

plConfCaps

Field with one or more of the following bits set:

0x00	Not capable of conferencing.
0x01	Data conferencing.
0x02	Audio conferencing.
0x04	Video conferencing.

IConferenceManagerX::RemoteConference

HRESULT RemoteConference(
    IConferenceX **ppConference);

Indicates the Conference from which an application was activated by a remote node. This Conference object should then be used to communicate with the remote node. The calling application should use the Conference object to communicate with the remote node.

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 The Conference Manager object was not initialized.

ppConference: Address to receive an instance of the Conference object.

IConferenceManagerX::Conferences

HRESULT Conferences(
    IConferences **ppConferences);

Returns the collection of existing Conference objects. If there is a conference in progress, the person setting up the conference can choose to use that one instead of starting a new one.

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 The Conference Manager object was not initialized.

ppConferences: Address of a collection of Conference objects.

IConferenceManagerX::Users

HRESULT Users(
    IConfUsers **ppUsers);

Indicates a collection of users who can become participants in a conference. It returns a pointer to a collection of existing User objects.

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 The Conference Manager object was not initialized.

ppUsers: Address of a collection of User objects.

This method is not supported in the current version.

IConferenceManagerX::NullObject

HRESULT NullObject(
    IDispatch **pIDispatch);

Indicates the IDispatch pointer set to null.

Returns S_OK if the requested number of elements was returned.

pIDispatch: Address of the IDispatch pointer to be set to null.

IConferenceManagerX Methods

This section describes the methods for the IConferenceManagerX interface.

IConferenceManagerX::Initialize

HRESULT Initialize(
    BSTR bstrID,
    BOOLEAN *pfSucceeded);

Activates the Conference Manager object and enables the calling application to register itself to the conference services.

Returns one of the following values:

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

bstrID: Interface ID of the calling application (textual description of a globally unique identifier [GUID]).
pfSucceeded: TRUE if the conference was initialized successfully, or FALSE otherwise.

IConferenceManagerX::Uninitialize

HRESULT Uninitialize(void);

Release memory and other resources within the process to facilitate a subsequent call to Initialize. Must be called by scripts and Visual Basic® applications before the control is unloaded.

Returns S_OK if successful, or E_UNEXPECTED if an unknown error occurred.

If the Initialize method has not yet been called, it is not necessary to call Uninitialize.

IConferenceManagerX::CreateConference

HRESULT CreateConference(
    BSTR bstrName,
    LONG lConfCaps,
    IConferenceX **ppConference);

Retrieves an instance of a new Conference object.

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 The Conference Manager object was not initialized.

bstrName: String for the conference name.
lConfCaps: Bitmap for conferencing capabilities. See IConferenceManagerX::ConferenceCapabilities for a description of the values.
ppConference: Address to receive an instance of the Conference object.

IConferenceManagerX::CreateUser

HRESULT CreateUser(
    BSTR bstrName,
    LONG lType,
    IConfUserX **ppUser);

Retrieves an instance of a new User object.

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 The Conference Manager object was not initialized.

bstrName

String for the user's name or address.

lType

Constant that indicates the type of the user name/address. Can be one of the following values:

CNF_USER_IP	The user name contains an IP address.
CNF_USER_MACHINENAME	The user name contains a computer name.
CNF_USER_UNKNOWN	The transport is unknown.

ppUser

Address to receive an instance of the User object.

IConferenceManagerX::Advise

HRESULT Advise(void);

Enables advisements (events) for the IConferenceManagerX interface.

Returns S_OK if successful, or E_UNEXPECTED if an unknown error occurred.

IConferenceManagerX::Unadvise

HRESULT Unadvise(void);

Disables advisements (events) for the IConferenceManagerX interface.

Returns S_OK if successful, or E_UNEXPECTED if an unknown error occurred.

Events

This section describes the events fired by the control. All events are fired by the Conference Manager object.

InvitedToConference

void InvitedToConference(
    IConfUserX *pUser,
    IConferenceX *pConference);

Retrieves a pointer to the conference that the called application is being invited to join.

pUser: User who invited the local computer to the conference.
pConference: Instance of the Conference object.

This event is not supported in the current version.

ConferenceCreated

void ConferenceCreated(
    IConferenceX *pConference);

Fires when a new conference is activated by other applications. The Conference object can be used as if it were activated by the client application.

pConference: Instance of the Conference object.

StateChanged

void StateChanged(
    IConferenceX *pConference,
    LONG lConfState,
    LONG hr);

Fires when the status of the conference has changed.

pConference: Instance of the Conference object.
lConfState: State of the conference.
hr: Result of the status change operation.

RequestToJoin

void RequestToJoin(
    IConferenceX *pConference,
    IConfUserX *pUser);

Fires when a user has made a request to join a conference.

pConference: Instance of the Conference object to be joined.
pUser: Instance of the User object that wants to join the conference.

This event is not supported in the current version.

MemberChanged

void MemberChanged(
    IConferenceX *pConference,
    IConfMemberX *pMember,
    LONG lNotify);

Fires when the member roster for the conference has changed (someone has joined or left the conference).

pConference

Instance of the Conference object.

pMember

Instance of the Member object that is added or removed from the conference.

lNotify

Constant for the notification type. Can be one of the following values:

CNF_MEMB_ADDED	The member is being added to the conference.
CNF_MEMB_REMOVED	The member is being removed from the conference.
CNF_MEMB_UPDATED	The member information is changed.

ChannelChanged

void ChannelChanged(
    IConferenceX *pConference,
    IConfChannelX *pChannel,
    LONG lNotify);

Fires when a channel has been added or removed from a conference.

pConference

Instance of the Conference object.

pChannel

Instance of the Channel object that is added or removed from the conference

lNotify

Constant for the notification type. Can be one of the following values:

CNF_CHAN_ADDED	The channel is being added to the conference.
CNF_CHAN_REMOVED	The channel is being removed from the conference.

This event is not supported in the current version.

DataSent

void DataSent(
    IConfDataExchangeX *pDataExchange,
    IConfMemberX *pMember,
    IConfDataTransferX *pDataTransfer,
    LONG hr);

Fires when data has been sent, and indicates the result of the operation

pDataExchange: Address of the ConfDataExchange object used to send the data.
pMember: Instance of the Member object that received the data. This parameter's value is NULL if the data was sent to all members.
pDataTransfer: IConfDataTransferX object.
hr: Result of the data transfer.

DataReceived

void DataReceived(
    IConfDataExchangeX *pDataExchange,
    IConfMemberX *pMember,
    IConfDataTransferX *pDataTransfer,
    LONG hr);

Fires when data has been received.

pDataExchange: Address to the ConfDataExchange object used to send the data
pMember: Instance of the Member object that sent the data.
pDataTransfer: IConfDataTransferX object.
hr: Result of the data transfer.

The data buffer is valid only during the event notification, that is, the data buffer is freed by the source object after the event notification.

FileSent

void FileSent(
    IConfFileExchangeX *pFileExchange,
    IConfMemberX *pMember,
    IConfFileTransferX *pFileTransfer,
    LONG hr);

Fires when a file has been sent.

pFileExchange: Address of the File Exchange object that was used to send the file.
pMember: Instance of the Member object where the file is sent. Will be NULL if the file was sent to everyone.
pFileTransfer: Instance of the File Transfer Channel.
hr: Result of the data transfer.

This event can be fired multiple times to get progress information from the ConfFileTransfer object.

FileReceived

void FileReceived(
    IConfFileExchangeX *pFileExchange,
    IConfMemberX *pMember,
    IConfFileTransferX *pFileTransfer,
    LONG hr);

Fires when a file has been received.

pFileExchange: Address of the ConfFileExchange object that was used to receive the file.
pMember: Instance of the Member object where the file is received.
pFileTransfer: Instance of the File Transfer Channel.
hr: Result of the data transfer.

This event can be fired multiple times to get progress information.

AppSharingStatusChanged

void AppSharingStatusChanged(
    IConfAppSharingX *pAppSharing,
    IConfShareAppX *pShrApp,
    LONG lAppStatus
    LONG hr);

Fires when a sharable application becomes shared or unshared.

pAppSharing

Address of the App Sharing channel.

pShrApp

Instance of the Sharable Application object.

lAppStatus

Current sharing status. Can be one of the following values:

CNF_SHR_SHARED	The application is shared.
CNF_SHR_UNSHARED	The application is not shared.

hr

Result of the application sharing operation.

AppControlStatusChanged

void AppControlStatusChanged(
    IConfAppControlX *pAppControl,
    IConfMemberX *pMember,
    IConfApplicationX *pApplication,
    LONG lAppStatus
    LONG hr);

Fires when the remote instance of an application on a member's computer changes its status.

pAppControl

Address of the App Control channel.

pMember

Member object whose application instance is changing its status.

pApplication

Instance of the Application object.

lAppStatus

Current sharing status for application invocation. Can be one of the following values:

CNF_APP_STARTED	The remote instance of the application is started.
CNF_APP_STOPPED	The remote instance of the application is stopped.
CNF_APP_UNKNOWN	The state of the remote instance of the application is unknown.

hr

Result of the application sharing operation.