Channel Object

The Channel object provides the following interfaces:

• IConfChannelX
• IConfDataExchangeX
• IConfFileExchangeX
• IConfAppSharingX
• IConfAppControlX

Back to ActiveX Reference

IConfChannelX

This interface provides the following properties:

• Conference
• Interface
• Members
• Object

and the following methods:

• IncludeMember
• ExcludeMember
• IsSameAs

IConfChannelX Properties

This section describes the properties for the IConfChannelX interface.

IConfChannelX::Conference

HRESULT Conference(
    IConferenceX **ppConference);

Indicates the Conference object to which the channel belongs.

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

ppConference

Address of a collection of instances of the Conference object.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfChannelX::Interface

HRESULT Interface(
    BSTR *pbstrID);

Indicates a Channel-specific interface identifier.

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

pbstrID

Address of an interface's unique identifier.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfChannelX::Members

HRESULT Members(
    IConfMembers **ppMembers);

Indicates a collection of Member objects that are currently enabled to use the channel.

• 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 to receive the Member object enumerator.

This property is not supported in the current version.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfChannelX::Object

HRESULT Object(
    IDispatch **ppObject);

Retrieves either a data exchange object, a file exchange object, an app control object, or an app sharing object, depending on the channel type.

• 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.

ppObject

Address to receive the data exchange, file exchange, app control, or app sharing object.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfChannelX Methods

This section describes the methods for the IConfChannelX interface.

IConfChannelX::IncludeMember

HRESULT IncludeMember(
    IConfMemberX *pMember,
    BOOLEAN *pfSucceeded);

Enables a Member object to use the channel.

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

pMember

Instance of the Member object to be given use of the channel.

pfSucceeded

TRUE if the request to use the channel is accepted, or FALSE otherwise.

This method is not supported in the current version.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfChannelX::ExcludeMember

HRESULT ExcludeMember(
    IConfMemberX *pMember,
    BOOLEAN *pfSucceeded);

Prevents a Member object from using the channel.

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

pMember

Instance of the Member object to be prevented from using the channel.

pfSucceeded

TRUE if the request to exclude a member is accepted, or FALSE otherwise.

This method is not supported in the current version.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfChannelX::IsSameAs

HRESULT IsSameAs(
    IConfChannelX *pConfChannel,
    BOOLEAN *pfSame);

Indicates whether the two Channel objects represent the same channel.

• Returns S_OK if both Channel objects represent the same channel, or S_FALSE if not.

pConfChannel

Instance of the Channel object to compare with.

pfSame

TRUE if it is the same channel, or FALSE otherwise.

Back to IConfChannelX Interface

Back to Channel Object

Back to ActiveX Listing

IConfDataExchangeX

This interface provides the following methods:

• SendData
• Advise
• Unadvise

IConfDataExchangeX Methods

This section describes the methods for the IConfDataExchangeX interface.

IConfDataExchangeX::SendData

HRESULT SendData(
    IConfMemberX *pMember,
    IConfApplicationX *pApplication,
    VARIANT data,
    LONG lOptions,
    BOOLEAN *pfSucceeded);

Sends a block of data bytes through the channel to a specified application on the specified member's computer. The buffer can be freed any time after calling this method.

• 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.

pMember

Instance of the Member object to send data to. If the parameter is NULL, the data is sent to all the members in the channel.

pApplication

Instance of the Application object to send data to. If the parameter is NULL, the data is sent to the remote instance of the calling application.

data

Data to be sent. Can be either a string or an array of bytes, integers, and so on.

lOptions

Flags for data transfer options. Can be the following value:

CNFF_SDOPT_NONE

No option is specified.

pfSucceeded

TRUE if the data transfer succeeded, or FALSE otherwise.

Back to IConfDataExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfDataExchangeX::Advise

HRESULT Advise(void);

Enables advisements (events) for this object.

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

Back to IConfDataExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfDataExchangeX::Unadvise

HRESULT Unadvise(void);

Disables advisements (events) generated by the object.

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

Back to IConfDataExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfFileExchangeX

This interface provides the following properties:

• GetReceiveFileDir
• SetReceiveFileDir

and the following methods:

• SendFile
• Cancel
• Advise
• Unadvise

IConfFileExchangeX Property

This section describes the property for the IConfFileExchangeX interface.

IConfFileExchangeX::GetReceiveFileDir

HRESULT GetReceiveFileDir(
    BSTR *pbstrDir);

Gets the path of the directory where received files will be stored.

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

pbstrDir

Address to receive a string for the path of the directory where received files will be stored.

Back to IConfFileExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfFileExchangeX::SetReceiveFileDir

HRESULT SetReceiveFileDir(
    BSTR strDir);

Sets the path of the directory where the received file will be stored on the local computer.

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

strDir

String for the path of the directory where a received file will be stored.

Back to IConfFileExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfFileExchangeX Methods

This section describes the methods for the IConfFileExchangeX interface.

IConfFileExchangeX::SendFile

HRESULT SendFile(
    IConfMemberX *pMember,
    IConfApplicationX *pApplication,
    BSTR bstrFile,
    LONG lOptions,
    IConfFileTransferX **ppFileTransfer);

Sends a file through the channel.

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

pMember

Member object that will receive the file. If the parameter is NULL, the file is sent to all members in the channel.

pApplication

Application object that will receive the transfer progress notification. If the parameter is NULL, the notification is sent to the remote instance of the calling application.

bstrFile

Full path of the file to be sent.

lOptions

Flags for file transfer options. Can be one of the following values:

CNFF_SFOPT_NOCOMPRESS	The file should not be compressed.
CNFF_SFOPT_NONE	No option is specified.
CNFF_SFOPT_NOUI	The default progress dialog user interface should not be used.

ppFileTransfer

Address of a buffer to receive a File Transfer Channel.

Back to IConfFileExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfFileExchangeX::Cancel

HRESULT Cancel(
    IConfFileTransferX *pFileTransfer,
    BOOLEAN *pfSucceeded);

Cancels the file being sent or received.

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

pFileTransfer

Instance of a File Transfer Channel being sent or received.

pfSucceeded

TRUE if the send is canceled, or FALSE otherwise.

Back to IConfFileExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfFileExchangeX::Advise

HRESULT Advise(void);

Enables advisements (events) for this interface.

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

Back to IConfFileExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfFileExchangeX::Unadvise

HRESULT Unadvise(void);

Disables advisements (events) for this interface.

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

Back to IConfFileExchangeX Interface

Back to Channel Object

Back to ActiveX Listing

IConfAppSharingX

This interface provides the following property:

• SharableApps

and the following methods:

• Advise
• Unadvise

IConfAppSharingX Property

This section describes the property for the IConfAppSharingX interface.

IConfAppSharingX::SharableApps

HRESULT SharableApps(
    IConfShareApps **ppSharableApps);

Retrieves a pointer to a collection of the Sharable Applications objects for the applications that can be shared.

• 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.

ppSharableApps

Address of a collection of sharable applications.

Back to IConfAppSharingX Interface

Back to Channel Object

Back to ActiveX Listing

IConfAppSharingX Methods

This section describes the methods for the IConfAppSharingX interface.

IConfAppSharingX::Advise

HRESULT Advise(void);

Enables advisements (events) for this interface.

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

Back to IConfAppSharingX Interface

Back to Channel Object

Back to ActiveX Listing

IConfAppSharingX::Unadvise

HRESULT Unadvise(void);

Disables advisements (events) for this interface.

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

Back to IConfAppSharingX Interface

Back to Channel Object

Back to ActiveX Listing

IConfAppControlX

This interface provides the following methods:

• StartRemoteInstance
• Advise
• Unadvise

IConfAppControlX Methods

This section describes the methods for the IConfAppControlX interface.

IConfAppControlX::StartRemoteInstance

HRESULT StartRemoteInstance(
    IConfMemberX *pMember,
    IConfApplicationX *pApplication,
    BOOLEAN *pfSucceeded);

Accepts an Application object and starts an instance of the application on the specified member's computer.

• 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.

pMember

Member object where the remote instance of the application will be started. If the parameter is NULL, the application will be started on all members in the channel.

pApplication

Application object whose remote instance will be started. If the parameter is NULL, the method starts the remote instance of the calling application.

pfSucceeded

TRUE if the application was started, or FALSE otherwise.

Back to IConfAppControlX Interface

Back to Channel Object

Back to ActiveX Listing

IConfAppControlX::Advise

HRESULT Advise(void);

Enables advisements (events) for this interface.

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

Back to IConfAppControlX Interface

Back to Channel Object

Back to ActiveX Listing

IConfAppControlX::Unadvise

HRESULT Unadvise(void);

Disables advisements (events) for this interface.

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

Back to IConfAppControlX Interface

Back to Channel Object

Back to ActiveX Listing

Last Updated: November 1, 1997
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.