XferAddFile Method

Navigation:  Reference Guide > File Transfer >

XferAddFile Method

Previous pageReturn to chapter overviewNext page

Informs MegaPipe of the name of file which will be uploaded to the remote side for a communication channel (direct serial connection or modem connection).

XferAddFile(short ChannelID, BSTR FileName, VARIANT_BOOL *Result);

Parameters

ChannelID

    A channel ID (0-7) used to identify a communication channel.

FileName

    A pointer to a null-terminated string containing the relevant path name of file which will be uploaded to the remote side.

Result

    If the method succeeds, the value of variable pointed to by Result is VARIANT_TRUE, otherwise the value is VARIANT_FALSE.

 

Remarks

All XModem protocols can only upload 1 file during one file-transfer session, your application only needs to call this API once for a communication channel.

 

YModem, YModem-G, ZModem and Kermit can upload multiple files during one file-transfer session, so your application maybe needs to call this API a few times if multiple files are uploaded for a communication channel.