Reflection Desktop VBA Guide
Attachmate.Reflection.Objects.Emulation.IbmHosts Library / Attachmate.Reflection.Objects.Emulation.IbmHosts Library / FileTransfer Object
Properties Methods

In This Topic
    FileTransfer Object Members
    In This Topic

    The following tables list the members exposed by FileTransfer.

    Public Properties
     NameDescription
    Public PropertyDfltExistsActionGets or sets what happens during an IND$FILE transfer if the destination file already exists.  
    Public PropertyDfltXfrTypeGets or sets the default type for Mainframe transfers. This property is only relevant for 3270 sessions using Mainframe transfer.  
    Public PropertyHostFileListMacroGets or sets the macro that runs when you click the Show Host Files button in the Transfer dialog box.  
    Public PropertyIndAutoPositionCursorGets or sets whether Reflection enters IND$FILE commands into the last unprotected field on the screen. This property affects file transfer done using the Transfer dialog box, and also using the IndReceiveFile and IndSendFile methods. This property applies only to 3270 terminal sessions.  
    Public PropertyParentGets the parent object.  
    Public PropertyShowDISOSSStatusDialogGets or sets whether to display the transfer-in-progress "thermometer" when receiving data from the host during DISOSS transfers.  
    Public PropertyTransferTypeGets or sets the transfer protocol Reflection uses.  
    Public PropertyXfr400AssumePositiveNumericsGets or sets whether Reflection looks for a negative sign (-) or a blank (positive) in the first byte of numeric fields in fixed column ASCII database files.  
    Public PropertyXfr400AuthorityGets or sets the level of authority to associate with a file that is transferred to the host.  
    Public PropertyXfr400CharsetGets or sets the ANSI or ASCII character set for transfers to and from an AS/400.  
    Public PropertyXfr400CompatibleAsciiFileGets or sets whether Reflection uses the buffer length instead of the field length of a packed decimal field to determine the size of fields on the PC.  
    Public PropertyXfr400CompatibleFDFFileGets or sets whether Reflection denotes a number's digit/decimal characteristics in file description files in the same style as RUMBA.  
    Public PropertyXfr400DateFormatGets or sets the date format for selected fields that have an AS/400 field type of date.  
    Public PropertyXfr400DateSeparatorGets or sets a character to use as a date separator in selected fields that have an AS/400 field type of date.  
    Public PropertyXfr400DecSepGets or sets a character to use as a decimal separator in selected fields that have an AS/400 field type of packed decimal or zoned decimal.  
    Public PropertyXfr400DeleteTrailingSpacesGets or sets whether extra spaces at the end of a record are deleted when the records are transferred to the PC during AS/400 data transfers.  
    Public PropertyXfr400ExistsActionGets or sets what Reflection does if it finds a PC file with the same name as the host file or member that you are trying to receive.  
    Public PropertyXfr400FileTextGets or sets a description for the new host file. This description appears in AS/400-generated lists, such as WRKOBJ displays, and as a Tooltip in the Transfer dialog box.  
    Public PropertyXfr400ForceHexConversionGets or sets whether Reflection translates data in coded character set ID (CCSID) 65535 from hexadecimal to EBCDIC when sending it to the host or to ANSI when receiving it from the host.  
    Public PropertyXfr400GroupByStringGets or sets how to group returned data after a requested function is performed.  
    Public PropertyXfr400HavingStringGets or sets a string that imposes a condition on a function of the Select statement.  
    Public PropertyXfr400HostFileTypeGets or sets the type of host file to create.  
    Public PropertyXfr400HostTPGets or sets which host transaction program (TP) Reflection uses.  
    Public PropertyXfr400IgnoreDecErrorsGets or sets whether Reflection ignores any decimal data errors found in a packed or zoned field during a transfer from an AS/400.  
    Public PropertyXfr400JoinByStringGets or sets how to combine data from multiple files.  
    Public PropertyXfr400LocalFileGets or sets the name of the PC file to send or receive in AS/400 data transfers.  
    Public PropertyXfr400MemberTextGets or sets a new member description which appears in AS/400-generated lists, such as WRKMBRPDM, and as a Tooltip in the Transfer dialog box.  
    Public PropertyXfr400NCSGets or sets the character set Reflection uses for character translations in AS/400 data transfers.  
    Public PropertyXfr400NumDisplayRecordsGets or sets the number of records displayed in the Query Results window when host records are transferred to the screen display (instead of to a file).  
    Public PropertyXfr400ObjectsGets or sets whether data is transferred to a new member on the AS/400 or to an existing member, and whether the file that contains the member already exists.  
    Public PropertyXfr400OrderByStringGets or sets how to sort selected records.  
    Public PropertyXfr400OutputDestGets or sets whether host data is received to a PC file or to the screen display.  
    Public PropertyXfr400ReceiveConversionGets or sets a conversion format for files received from an AS/400.  
    Public PropertyXfr400ReceiveDescFileGets or sets a description file to receive during a transfer from an AS/400 to the PC.  
    Public PropertyXfr400RecordLengthGets or sets (second syntax line) the record size (in bytes) for files created on the host.  
    Public PropertyXfr400RefFileGets or sets the reference file that will be used to set the definitions of fields for the new AS/400 file.  
    Public PropertyXfr400RemoteFileGets or sets the host file that the PC receives (for transfers from the host) or to which data from the PC is sent (for transfers to the host).  
    Public PropertyXfr400ReturnMissingGets or sets whether records that contain values for missing fields should be returned.  
    Public PropertyXfr400SaveDescriptionFileGets or sets whether to save the description file during transfers from an AS/400 to a PC.  
    Public PropertyXfr400SelectStringGets or sets which fields to transfer.  
    Public PropertyXfr400SendConversionGets or sets a conversion format for files sent to an AS/400. This property affects AS/400 data transfer and is only relevant for 5250 sessions.  
    Public PropertyXfr400SendDescFileGets or sets the description file to send during transfers to an AS/400 from the PC.  
    Public PropertyXfr400ShowProgressGets or sets whether or not to display the transfer-in-progress "thermometer" when receiving data from the host.  
    Public PropertyXfr400SortSeqGets or sets a sort sequence for the data being transferred. The specified sort sequence determines the order of characters in the alphabet when fields are alphabetized.  
    Public PropertyXfr400StartRecordUse this property to skip a given number of records at the start of a file before sending the file to the AS/400.  
    Public PropertyXfr400TimeFormatGets or sets the time format for selected fields having an AS/400 field type of Time.  
    Public PropertyXfr400TimeSeparatorGets or sets a character to use as a time separator in selected fields having an AS/400 field type of Time.  
    Public PropertyXfr400TransportGets or sets the protocol to use for data transfers.  
    Public PropertyXfr400UseDescriptionFileGets or sets whether a description file should be used when sending a PC file to an AS/400.  
    Public PropertyXfr400WhereStringGets or sets one or more conditions that determine whether a record is transferred.  
    Public PropertyXfr8Dot3FilenameCaseGets or sets how the names of PC files created in 16-bit applications are displayed in the Transfer dialog box.  
    Public PropertyXfrAddParamGets or sets any additional parameters that should be appended to IND$FILE commands that Reflection generates. This property is applicable 3270 sessions only.  
    Public PropertyXfrApvUserGets or sets whether shift-out and shift-in (SO/SI) characters in the host file are left intact (not translated) during JISCII file translations when the host has the NOSO option selected.  
    Public PropertyXfrAsciiCrlfGets or sets whether a carriage return and a line-feed character are removed from the end of each line of an ASCII file you are sending to the host, or added to the end of each line of an ASCII file you are receiving from the host.  
    Public PropertyXfrBinaryCRLFGets or sets whether a carriage return and a line-feed character are removed from the end of each line of a binary file that you send to the host, or added to the end of each line of a binary file that you receive from the host.  
    Public PropertyXfrCloseDlgAfterTransferGets or sets whether Reflection closes the File Transfer dialog box upon completion of a file transfer.  
    Public PropertyXfrCurrentDirectoryGets or sets the current local working folder for file transfer.  
    Public PropertyXfrEnableTemplatesGets or sets whether file transfer templates are enabled in 3270 terminal sessions.  
    Public PropertyXfrFtpLocalFileGets or sets a file on the PC.  
    Public PropertyXfrFtpRemoteFileGets or sets a host file.  
    Public PropertyXfrHostCmdGets or sets the name of the host program to be run by Reflection to initiate a file transfer.  
    Public PropertyXfrHostMessageGets or sets any message returned to Reflection by the host file transfer program after a transfer completes.  
    Public PropertyXfrHostReturnCodeThis property returns a numeric value which indicates success or failure by the transfer program after a transfer is completed.  
    Public PropertyXfrHostSysGets or sets which 3270 operating environment the host is running. This property determines which Advanced Options are available from the Transfer dialog box in 3270 sessions.  
    Public PropertyXfrIndAllocUnitGets or sets the unit of disk space for your primary and secondary space allocations.  
    Public PropertyXfrIndAvgBlkGets or sets the size (in bytes) for an average block.  
    Public PropertyXfrIndBlkSizeGets or sets the block size (in bytes) for the file being created on the host as the result of a transfer.  
    Public PropertyXfrIndLReclGets or sets the record size (in bytes) for files being created on the host as the result of a transfer.  
    Public PropertyXfrIndNOSOGets or sets whether to remove the shift-out/shift-in (SO/SI) characters from files sent to the host.  
    Public PropertyXfrIndPrimAllocGets or sets the size (in Allocation Units, as specified by the XfrIndAllocUnit property) of the primary allocation for the host file being created by an IND$FILE transfer.  
    Public PropertyXfrIndRecFmGets or sets the record format for files being created on the host by an IND$FILE transfer.  
    Public PropertyXfrIndSecAllocGets or sets the size of any additional allocations (in Allocation Units, as specified by the XfrIndAllocUnit property) in the event that the primary allocation is not sufficient.  
    Public PropertyXfrIndSOGets or sets whether to convert shift-in (SI) characters to US (hex 1F) and shift-out (SO) characters to RS (hex 1E) in JISCII files received from the host.  
    Public PropertyXfrIndStrucFldSzGets or sets whether Reflection uses the Write Structured Field protocol for IND$FILE transfers and, if so, sets the buffer size.  
    Public PropertyXfrJisciiCrlfGets or sets whether a carriage return and a line-feed character are removed from the end of each line of a JISCII file that you send to the host, or added to the end of each line of a JISCII file that you receive from the host.  
    Public PropertyXfrLocalFileGets or sets a default PC file or files for the PC to receive (for transfers from the host), or for the host to receive (for transfers to the host).  
    Public PropertyXfrReceive8Dot3Gets or sets whether long filenames received from an IBM mainframe are truncated.  
    Public PropertyXfrRemoteFileGets or sets host files for the PC to receive (for transfers from the host), or for the host to receive (for transfers to the host).  
    Public PropertyXfrSpacesToUnderscoresGets or sets whether to translate spaces in a file name to underscores during a transfer to a mainframe or AS/400.  
    Public PropertyXfrStartTimeoutGets or sets the length of time (in seconds) that Reflection waits for a host response when attempting to connect to a host.  
    Public PropertyXfrTimeoutGets or sets the length of time (in seconds) that Reflection waits for a host response before timing out and returning an error.  
    Public PropertyXfrUnderscoresToSpacesGets or sets whether underscores in filenames are converted to spaces when receiving files from an IBM mainframe or AS/400 system.  
    Top
    Public Methods
     NameDescription
    Public MethodAbortTransferAborts an IND$FILE transfer.  
    Public MethodAS400ReceiveFileTransfers data from the host to the PC using the AS/400 data transfer protocol.  
    Public MethodAS400SendFileTransfers one or more PC files to the host using the AS/400 data transfer protocol.  
    Public MethodCancelTransferCancels an IND$FILE transfer or AS/400 data transfer in progress. If the host has stopped responding, you may need to use the AbortTransfer method instead.  
    Public MethodINDReceiveFileTransfers a file from the host to the PC using the IND$FILE protocol.  
    Public MethodINDSendFileTransfers a file from the PC to the host using the IND$FILE protocol.  
    Public MethodOpen

    Opens a transfer request file. This is equivalent to opening a Transfer Request (.mto or .xto) file using the Open button in the File Transfer dialog.

     
    Public MethodShowFileTransferDialogOpens the File Transfer dialog box.  
    Public MethodShowFileTransferSetupDialogOpens the Transfer Setup dialog box. This method returns an error if the user cancels the dialog box.  
    Top
    See Also

    Reference

    FileTransfer Object
    Attachmate.Reflection.Objects.Emulation.IbmHosts Library

    Send Feedback