![]() |
![]() |
![]() |
![]() |
All events fired by the control go through the Conference Manager object. The following hierarchy shows the control's objects, and the properties, methods, and events for each. Brackets indicate the object from which each event originates.
The Conference Manager object provides the following interface:
The IConferenceManagerX interface provides the following properties:
and the following methods:
Following is a description of the properties for the IConferenceManagerX interface.
HRESULT ConferenceCapabilities( LONG *plConfCaps);
Indicates which types of conferences (audio, data, or video) are available on the local computer.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | The Conference Manager object was not initialized. |
CNFF_CAPS_NONE | Not capable of conferencing. |
CNFF_CAPS_DATA | Data conferencing. |
CNFF_CAPS_AUDIO | Audio conferencing. |
CNFF_CAPS_VIDEO | Video conferencing. |
HRESULT RemoteConference( IConferenceX **ppConference);
Indicates the ongoing Conference object from which the application was remotely activated by a remote node. The calling application should use the Conference object to communicate with the remote node.
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. |
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.
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. |
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.
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. |
This method is not supported in the current version.
HRESULT NullObject( IDispatch **pIDispatch);
Indicates the IDispatch pointer set to null.
S_OK | Success. The requested number of elements was returned. |
Following is a description of the methods for the IConferenceManagerX interface.
HRESULT Initialize( BSTR bstrID, BOOLEAN *pfSucceeded);
Activates the Conference Manager object and allows the calling application to register itself to the conference services.
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. |
HRESULT Uninitialize(void);
Must be called by scripts and Visual Basic applications before the control is unloaded.
S_OK | Success. |
E_UNEXPECTED | An unknown error occurred. |
If the Initialize method has not yet been called, it is not to call Uninitialize.
HRESULT CreateConference( BSTR bstrName, LONG lConfCaps, IConferenceX **ppConference);
Retrieves an instance of a new Conference object.
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. |
HRESULT CreateUser( BSTR bstrName, LONG lType, IConfUserX **ppUser);
Retrieves an instance of a new User object.
E_OUTOFMEMORY | Memory could not be allocated to service the request. |
E_UNEXPECTED | The Conference Manager object was not initialized. |
S_OK | Success. The requested number of elements was returned. |
CNF_USER_UNKNOWN | The transport is unknown. |
CNF_USER_IP | The user name contains an IP address. |
CNF_USER_MACHINENAME | The user name contains a computer name. |
CNF_USER_PSTN | The user name contains a telephone number. |
HRESULT Advise(void);
Enables advisements (events) for the IConferenceManagerX interface.
S_OK | Success. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unadvise(void);
Disables advisements (events) for the IConferenceManagerX interface.
S_OK | Success. |
E_UNEXPECTED | An unknown error occurred. |
Following are the events fired by the control. All events are fired by the Conference Manager object.
void InvitedToConference( IConfUserX *pUser, IConferenceX *pConference);
Retrieves a pointer to the conference that the called application is being invited to join.
This event is not supported in the current version.
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.
void StateChanged( IConferenceX *pConference, LONG lConfState, LONG hr);
Fires when the status of the conference has changed.
void RequestToJoin( IConferenceX *pConference, IConfUserX *pUser);
Fires when a user has made a request to join a conference.
This event is not supported in the current version.
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).
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. |
void ChannelChanged( IConferenceX *pConference, IConfChannelX *pChannel, LONG lNotify);
Fires when a channel has been added or removed from a conference.
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.
void DataSent( IConfDataExchangeX *pDataExchange, IConfMemberX *pMember, IConfDataTransferX *pDataTransfer, LONG hr);
Fires when data has been sent, and indicates the result of the operation.
void DataReceived( IConfDataExchangeX *pDataExchange, IConfMemberX *pMember, IConfDataTransferX *pDataTransfer, LONG hr);
Fires when data has been received.
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.
void FileSent( IConfFileExchangeX *pFileExchange, IConfMemberX *pMember, IConfFileTransferX *pFileTransfer, LONG hr);
Fires when a file has been sent.
This event can be fired multiple times to get progress information from the ConfFileTransfer object.
void FileReceived( IConfFileExchangeX *pFileExchange, IConfMemberX *pMember, IConfFileTransferX *pFileTransfer, LONG hr);
Fires when a file has been received.
It can be fired multiple times to get progress information.
void AppSharingStatusChanged( IConfAppSharingX *pAppSharing, IConfShareAppX *pShrApp, LONG lAppStatus LONG hr);
Fires when a sharable application becomes shared or unshared.
CNF_SHR_SHARED | The application is shared. |
CNF_SHR_UNSHARED | The application is not shared. |
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.
CNF_APP_UNKNOWN | The state of the remote instance of the application is unknown. |
CNF_APP_STARTED | The remote instance of the application is started. |
CNF_APP_STOPPED | The remote instance of the application is stopped. |
The User object provides the following interface:
The IConfUserX interface provides the following properties:
Following is a description of the properties for the IConfUserX interface.
HRESULT Name( BSTR *pbstrName);
Indicates a user name string.
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. |
HRESULT Type( LONG *plType);
Indicates the type of name for the User object.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT ConferenceCapabilities( LONG *plConfCaps);
Indicates which types of conferences (audio, data, or video) are available on the user's computer.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This property is not supported in the current version.
HRESULT IsMCU( BOOLEAN *pfMCU);
Indicates whether the user is a multipoint control unit (MCU).
S_OK | User is an MCU. |
S_FALSE | User is not an MCU. |
This property is not supported in the current version.
HRESULT Conferences( IConferences **ppConferences);
Indicates a collection of Conference objects that a user is participating in.
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. |
This property is not supported in the current version.
HRESULT Applications( IConfApplications **ppApplications);
Indicates a collection of Client Application objects for a user.
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. |
This property is not supported in the current version.
The Conference object provides the following interface:
The IConferenceX interface provides the following properties:
and the following methods:
Following is a description of the properties for the IConferenceX interface.
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.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Capabilities( LONG *plConfCaps);
Indicates which types of conferences (audio, data, video) the conference was originally created with.
E_UNEXPECTED | An unknown error occurred. |
S_OK | Success. The requested number of elements was returned. |
HRESULT State( LONG *plConfState);
Indicates the state of the conference.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
CNF_STATE_IDLE | The conference is idle (just created). |
CNF_STATE_INITIALIZING | The conference is being initialized. |
CNF_STATE_ACTIVE | The conference is active and can be used. |
CNF_STATE_STOPPING | The conference is being terminated. |
CNF_STATE_OFFERED | The conference is offered. |
HRESULT Members( IConfMembers **ppMembers);
Indicates a collection of existing Member objects when a conference is active.
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. |
HRESULT Applications( IConfApplications **ppApplications);
Indicates a collection of Client Application objects available to this conference.
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. |
HRESULT ChannelInterfaces( IChanInterfaces **ppChanInterfaces);
Indicates a collection of Channel interfaces available to the conference. The interfaces signify how the channel can be used.
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. |
HRESULT Channels( IConfChannels **ppChannels);
Indicates a collection of Channel objects available to the conference.
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. |
Following is a description of the methods for the IConferenceX interface.
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.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method is asynchronous (an event notification will be returned later if the invitee accepts).
HRESULT AcceptInvite( BOOLEAN *pfSucceeded);
Accepts an invitation to a conference.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method will not be implemented for the first release because SCRAPI does not support it. For the first release, invitations will have to be accepted from Microsoft NetMeeting.
HRESULT RejectInvite( BOOLEAN *pfSucceeded);
Rejects an invitation to a conference.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method will not be implemented for the first release because SCRAPI does not support it. For the first release, invitations will have to be rejected from Microsoft NetMeeting.
HRESULT Join( IConfUserX *pUser, BOOLEAN *pfSucceeded);
Joins a user who already has a conference running.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT AcceptJoin( IConfUserX *pUser, BOOLEAN *pfSucceeded);
Accepts a request from a user to join a conference.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method will not be implemented for the first release because SCRAPI does not support it. For the first release, joining will have to be accepted from Microsoft NetMeeting.
HRESULT RejectJoin( IConfUserX *pUser, BOOLEAN *pfSucceeded);
Rejects a request from a user to join a conference.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method will not be implemented for the first release because SCRAPI does not support it. For the first release, joining will have to be rejected from Microsoft NetMeeting.
HRESULT CreateChannel( BSTR bstrID, IConfChannelX **ppChannel);
Returns an instance of a new Channel object with the specified interface.
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. |
This method is not supported in the current version.
HRESULT Leave( BOOLEAN *pfSucceeded);
Removes the local computer from the active conference.
S_OK | Success. The requested number of elements was returned. |
S_FALSE | An unknown error occurred. |
HRESULT IsSameAs( IConferenceX *pConference, BOOLEAN *pfSame);
Identifies whether the two Conference objects represent the same conference.
S_OK | Both Conference objects represent the same conference. |
S_FALSE | Both Conference objects do not represent the same conference. |
HRESULT Advise(void);
Enables advisements (events) for the IConferenceX interface.
S_OK | Both Conference objects represent the same conference. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unadvise(void);
Disables advisements (events) for the IConferenceX interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The Member object is derived from the user:
The IConfMemberX interface provides the following properties:
and the following method:
Following is a description of the properties for the IConfMemberX interface.
HRESULT Name( BSTR *pbstrName);
Indicates a user name string.
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. |
HRESULT Type( LONG *plType);
Indicates the type of name for the User object.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT ConferenceCapabilities( LONG *plConfCaps);
Indicates which types of conferences (audio, data, or video) are available on the user's computer.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This property is not supported in the current version.
HRESULT IsMCU( BOOLEAN *pfMCU);
Indicates whether the user is a multipoint control unit (MCU).
S_OK | The user is an MCU. |
S_FALSE | The user is not an MCU. |
This property is not supported in the current version.
HRESULT Conferences( IConferences **ppConferences);
Indicates a collection of Conference objects that a user is participating in.
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. |
This property is not supported in the current version.
HRESULT Applications( IConfApplications **ppApplications);
Indicates a collection of Client Application objects for a user.
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. |
This property is not supported in the current version.
HRESULT Conference( IConferenceX **ppConference);
Indicates an instance of the Conference object to which the member belongs.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT IsSelf( BOOLEAN *pfSelf);
Identifies whether the Member object represents the local computer.
S_OK | The Member object represents the local computer. |
S_FALSE | The Member object does not represent the local computer. |
Following is a description of the method for the IConfMemberX interface.
HRESULT IsSameAs( IConfMemberX *pConfMember, BOOLEAN *pfSame);
Indicates whether two Member objects represent the same member.
S_OK | Both Conference objects represent the same conference. |
S_FALSE | Both Conference objects do not represent the same conference. |
The Channel object provides the following interfaces:
The IConfChannelX interface provides the following properties:
and the following methods:
Following is a description of the properties for the IConfChannelX interface.
HRESULT Conference( IConferenceX **ppConference);
Indicates the Conference object to which the channel belongs.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Interface( BSTR *pbstrID);
Indicates a Channel-specific interface identifier.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Members( IConfMembers **ppMembers);
Indicates a collection of Member objects that are currently allowed to use the channel.
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. |
This property is not supported in the current version.
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.
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. |
Following is a description of the methods for the IConfChannelX interface.
HRESULT IncludeMember( IConfMemberX *pMember, BOOLEAN *pfSucceeded);
Allows a Member object to use the channel.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method is not supported in the current version.
HRESULT ExcludeMember( IConfMemberX *pMember, BOOLEAN *pfSucceeded);
Prevents a Member object from using the channel.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
This method is not supported in the current version.
HRESULT IsSameAs( IConfChannelX *pConfChannel, BOOLEAN *pfSame);
Indicates whether the two Channel objects represent the same channel.
S_OK | Both Conference objects represent the same conference. |
S_FALSE | Both Conference objects do not represent the same conference. |
The IConfDataExchangeX interface provides the following methods:
Following is a description of the methods for the IConfDataExchangeX interface.
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 anytime after calling this method.
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. |
CNFF_SDOPT_NONE | No option is specified. |
HRESULT Advise(void);
Enables advisements (events) for this object.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unadvise(void);
Disables advisements (events) generated by the object.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The IConfFileExchangeX interface provides the following property:
and the following methods:
Following is a description of the property for the IConfFileExchangeX interface.
HRESULT ReceiveFileDir( BSTR *pbstrDir);
Sets the path of the directory where received files will be stored.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT ReceiveFileDir( BSTR strDir);
Sets the path of the directory where the received file will be stored on the local computer.
E_UNEXPECTED | An unknown error occurred. |
S_OK | Success. The requested number of elements was returned. |
Following is a description of the methods for the IConfFileExchangeX interface.
HRESULT SendFile( IConfMemberX *pMember, IConfApplicationX *pApplication, BSTR bstrFile, LONG lOptions, IConfFileTransferX **ppFileTransfer);
Sends a file through the channel.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
CNFF_SFOPT_NONE | No option is specified. |
CNFF_SFOPT_NOUI | The default progress dialog user interface should not be used. |
CNFF_SFOPT_NOCOMPRESS | The file should not be compressed. |
HRESULT Cancel( IConfFileTransferX *pFileTransfer, BOOLEAN *pfSucceeded);
Cancels the file being sent or received.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Advise(void);
Enables advisements (events) for this interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unadvise(void);
Disables advisements (events) for this interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The IConfAppSharingX interface provides the following property:
and the following methods:
Following is a description of the property for the IConfAppSharingX interface.
HRESULT SharableApps( IConfShareApps **ppSharableApps);
Retrieves a pointer to a collection of the Sharable Applications objects for the applications that can be shared.
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. |
Following is a description of the methods for the IConfAppSharingX interface.
HRESULT Advise(void);
Enables advisements (events) for this interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unadvise(void);
Disables advisements (events) for this interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The IConfAppControlX interface provides the following methods:
Following is a description of the methods for the IConfAppControlX interface.
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.
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. |
HRESULT Advise(void);
Enables advisements (events) for this interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unadvise(void);
Disables advisements (events) for this interface.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The Client Application object provides the following interface:
The IConfApplicationX interface provides the following properties:
Following is a description of the properties for the IConfApplicationX interface.
HRESULT GUID( BSTR *pbstrID);
Indicates a string form of an application's globally unique identifier (GUID).
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Name( BSTR *pbstrName);
Indicates an application name string.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The Sharable Application object provides the following interface:
The IConfShareAppX interface provides the following properties:
and the following methods:
Following is a description of the properties for the IConfShareAppX interface.
HRESULT Name( BSTR *pbstrName);
Indicates a string for the sharable application name.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT ShareState( LONG *puShrState);
Retrieves the "share" state of the application.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
CNF_SHR_UNKNOWN | The application state is unknown. |
CNF_SHR_SHARED | The application is being shared. |
CNF_SHR_UNSHARED | The application is not being shared. |
Following is a description of the methods for the IConfShareAppX interface.
HRESULT Share( BOOLEAN *pfSucceeded);
Shares the application on all the members in the channel.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Unshare( BOOLEAN *pfSucceeded);
Unshares the application on all the members in the channel.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The Data Transfer object provides the following interface:
The IConfDataTransferX interface provides the following properties:
Following is a description of the properties for the IConfDataTransferX interface.
HRESULT BytesTransferred( LONG *plBytes);
Indicates the number of bytes transferred.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT String( BSTR *pbstrData);
Retrieves the data to be transferred as a string.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT Array( LONG cbElements SAFEARRAY (unsigned char) *array);
Retrieves an array (SAFEARRAY) of the data to be transferred.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
The File Transfer object provides the following interface:
The IConfFileTransferX interface provides the following properties:
and the following method:
Following is a description of the properties for the IConfFileTransferX interface.
HRESULT Name( BSTR *pbstrName);
Indicates a string for the full path of the file.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT BytesTransferred( LONG *plBytes);
Indicates the number of bytes transferred.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT TotalSize( LONG *plBytes);
Indicates the size, in bytes, of the file.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
HRESULT State( LONG *plState);
Indicates the state of the File Transfer object.
S_OK | Success. The requested number of elements was returned. |
E_UNEXPECTED | An unknown error occurred. |
CNF_FILE_IDLE | The file-transfer operation was requested but not yet initialized. |
CNF_FILE_INITIALIZING | The file-transfer operation was requested but now initialized. |
CNF_FILE_PROGRESS | The file-transfer operation is in progress. |
CNF_FILE_COMPLETE | The file-transfer operation is completed. |
Note that the CNF_FILE_COMPLETE value can represent three reasons for file-transfer operation completion: success, cancellation, or failure.
Following is a description of the method for the IConfFileTransferX interface.
HRESULT IsSameAs( IConfFileTransfer *pFileTransfer, BOOLEAN *pfSame);
Indicates whether the two File Transfer objects represent the same file-transfer operation.
S_OK | Both File Transfer objects represent the same operation. |
S_FALSE | Both File Transfer objects do not represent the same operation. |
![]() |
![]() |
![]() |
![]() |