File Transfer Channel

The File Transfer Channel provides the following interface:

IConfFileTransferX

Back to ActiveX Reference

IConfFileTransferX

This interface provides the following properties:

and the following method:

IsSameAs

Back to File Transfer Channel

IConfFileTransferX Properties

This section describes the properties for the IConfFileTransferX interface.

IConfFileTransferX::Name

HRESULT Name(
    BSTR *pbstrName);

Indicates a string for the full path of the file.

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 full path of the file.

Back to IConfFileTransferX Interface

Back to File Transfer Channel

Back to ActiveX Listing

IConfFileTransferX::BytesTransferred

HRESULT BytesTransferred(
    LONG *plBytes);

Indicates the number of bytes transferred.

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

plBytes: Address of a collection of the number of bytes transferred.

Back to IConfFileTransferX Interface

Back to File Transfer Channel

Back to ActiveX Listing

IConfFileTransferX::TotalSize

HRESULT TotalSize(
    LONG *plBytes);

Indicates the size, in bytes, of the file.

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

plBytes: Address of a collection of the size, in bytes, of the file.

Back to IConfFileTransferX Interface

Back to File Transfer Channel

Back to ActiveX Listing

IConfFileTransferX::State

HRESULT State(
    LONG *plState);

Indicates the state of the File Transfer Channel.

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

plState

Address of a collection of the state of the file. Can be one of the following values:

CNF_FILE_COMPLETE	The file-transfer operation is completed.
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.

Note that the CNF_FILE_COMPLETE value can represent three reasons for file-transfer operation completion: success, cancellation, or failure.

Back to IConfFileTransferX Interface

Back to File Transfer Channel

Back to ActiveX Listing

IConfFileTransferX Methods

This section describes the method for the IConfFileTransferX interface.

IConfFileTransferX::IsSameAs

HRESULT IsSameAs(
    IConfFileTransfer *pFileTransfer, 
    BOOLEAN *pfSame);

Indicates whether the two File Transfer Channels represent the same file-transfer operation.

Returns S_OK if both File Transfer Channels represent the same operation, or S_FALSE if not.

pFileTransfer: Instance of the File Transfer Channel to compare with.
pfSame: TRUE if it is the same file transfer, or FALSE otherwise.

Back to IConfFileTransferX Interface

Back to File Transfer Channel

Back to ActiveX Listing