IFTPFXP Interface Reference

import "sfFTPLib.idl";

Public Member Functions
HRESULT	FXPFile ([in] BSTR sourceFile, [in] BSTR destinationFile, [in] long startPositionLo, [in] long startPositionHi)
	Transfers a file directly between two remote servers (FXP).
HRESULT	FXPFileEx ([in] LPCWSTR sourceFile, [in] LPCWSTR destinationFile, [in] ULONGLONG startPosition, [in] HANDLE cancelEvent)

Properties
IFTPConnection	Source [get, set]
	Sets or retrieves the source connection object.
IFTPConnection	Destination [get, set]
	Sets or retrieves the destination connection object.

Member Function Documentation

FXPFile()

HRESULT IFTPFXP::FXPFile	(	[in] BSTR	sourceFile,
		[in] BSTR	destinationFile,
		[in] long	startPositionLo,
		[in] long	startPositionHi )

Transfers a file directly between two remote servers (FXP).

This method initiates a server-to-server transfer (File Exchange Protocol).

Prerequisites:

• Connection Setup: The Source and Destination properties must be configured before calling this method.
• Port Configuration: The IFTPConnection::Passive property must be set to TRUE for one connection and FALSE for the other (Active/Passive bridge).
• Matching Settings: The following properties must be identical on both connections:
• DataTransferMode
• DataTransferType
• DataProtection

Secure Transfers (FTPS): When DataProtection is set to ftpDataProtectionPrivate (TLS enabled), you must set the IFTPConnection::SSCN (Set-Secure-Client-Negotiation) property to TRUE on one of the connections.

Network Limitations:

• IPv6 to IPv4: Not supported due to protocol limitations.
• IPv4 to IPv6: Supported only if the destination server also possesses a valid IPv4 address.

Parameters

[in]	sourceFile	The name of the file to retrieve from the source server.
[in]	destinationFile	The name of the file to store on the destination server.

Note

This must be a filename only; do not include path information.

Parameters

[in]	startPositionLo	The low-order 32 bits of the 64-bit resume offset.
[in]	startPositionHi	The high-order 32 bits of the 64-bit resume offset.

FXPFileEx()

HRESULT IFTPFXP::FXPFileEx	(	[in] LPCWSTR	sourceFile,
		[in] LPCWSTR	destinationFile,
		[in] ULONGLONG	startPosition,
		[in] HANDLE	cancelEvent )

Property Documentation

Destination

IFTPConnection IFTPFXP::Destination

getsetproperty

Sets or retrieves the destination connection object.

This property defines the target server for file transfers (e.g., FXP operations).

• Set (Put): Assigns an active IFTPConnection object to act as the destination (where files are written to).
• Get: Retrieves the current destination connection object.

Parameters

[in]	newValue	Pointer to the IFTPConnection interface to use as the destination.
[out]	retval	Receives the pointer to the current IFTPConnection destination.

Source

IFTPConnection IFTPFXP::Source

getsetproperty

Sets or retrieves the source connection object.

This property defines the origin server for file transfers (e.g., FXP operations).

• Set (Put): Assigns an active IFTPConnection object to act as the source (where files are read from).
• Get: Retrieves the current source connection object.

Parameters

[in]	newValue	Pointer to the IFTPConnection interface to use as the source.
[out]	retval	Receives the pointer to the current IFTPConnection source.

---

The documentation for this interface was generated from the following file:

• sfFTPLib.idl