The following methods are associated with the HFAppcFT class.
Abort()
This method aborts File Transfer. It is used in asynchronous mode only.
Parameters
None.
Return type
Public System.Booleanean: TRUE
Note
User will be notified by the EndOfFileTransfer event.
Connect (String sHFUser,String sHFPwd,String sSessionDesc,String sHostUser,String sHostPwd)
This method connects to Host.
Parameters
String sHFUser: Name of the HostFront client
String sHFPwd: Password of the HostFront client
String sSessionDesc: Reserved. Must be “”
String sHostUser: Name of the AS/400 user
String sHostPwd: password of the AS/400 user
Return type
Public System.Booleanean: TRUE upon succeeding, FALSE otherwise
Disconnect()
This method Disconnects from host.
Parameters
None.
Return type
Public System.Booleanean: TRUE upon succeeding, FALSE otherwise
Download (String sRemotePath,String sLocalPath,String sFDFFile)
This method downloads a remote member.
Parameters
String sRemotePath : AS/400 Member path = Library/file(member)
String sLocalPath : Path of the local file (Ex : C:\mydir\myfile.txt)
String sFDFFile : If not empty, specifies the local path of the associated format description file that will be created locally.
Return type
Public System.Booleanean: TRUE upon succeeding, FALSE otherwise.
Note
In asynchronous mode, the methods returns immediately with TRUE.
GetFiles (String sLibrary,VARIANT* pvNames ,VARIANT* pvDesc)
This method gets the list of files for a specified library.
Parameters
String sLibrary: Name of the parent library
VARIANT* pvNames: Array of strings that will receive the list of the files names.
VARIANT* pvDesc: Array of strings that will receive the list of the files descriptions.
Return type
Public System.Booleanean: TRUE on success, FALSE otherwise
GetLibraries (VARIANT* pvNames,VARIANT* pvDesc)
This method gets the list of libraries.
Parameters
VARIANT* pvNames : Array of strings that will receive the list of the libraries names.
VARIANT* pvDesc : Array of strings that will receive the list of the libraries descriptions.
Return type
Public System.Booleanean : TRUE on success , FALSE otherwise
VisualBasic code example
Public WithEvents FtObj As HfFt.HfAppcFT
.....
Dim varNames As Variant
Dim varDesc As Variant
Dim bRet As Public System.Booleanean
Dim i As Long
Dim StrArray() As String
bRet = FtObj.GetLibraries(varNames, varDesc)
If (bRet) Then
StrArray = varNames
For i = LBound(StrArray) To UBound(StrArray)
' StrArray(i) is the name of the library # i
Next i
End If
GetMembers (String sLibrary,String sFile,VARIANT* pvNames,VARIANT* pvDesc)
This method gets the list of members for a specified file and a specified library.
Parameters
String sLibrary: Name of the parent library
String sFile: Name of the parent file
VARIANT* pvNames: Array of strings that will receive the list of the member names.
VARIANT* pvDesc: Array of strings that will receive the list of the member descriptions.
Return type
Public System.Booleanean: TRUE upon succeeding, FALSE otherwise
SetDefaultOptions()
This method sets the default options. The method is also called when the object is created.
Parameters
None.
Return type
None.
| DateFormat |
eFTAPPC_DateFormat_AS400_Job_Default |
| DateSeparator |
eFTAPPC_DateSep_Host_Job_Default |
| TimeFormat |
eFTAPPC_TimeFormat_AS400_Job_Default |
| TimeSeparator |
eFTAPPC_TimeSep_Host_Job_Default |
| NumDataSeparator |
eFTAPPC_DataSep_PC_Default |
| PCFileType |
eFTAPPC_FileType_Ascii |
| UploadMemberStatus |
eFTAPPC_Up_Member_Status_Replace |
| UploadMemberType |
eFTAPPC_Up_Member_Type_Data |
| UploadAuthority |
eFTAPPC_Up_Authority_All |
| MemberRecordLength |
80 |
| IgnoreDecimalError |
FALSE |
| AsciiAnsiConversion |
TRUE |
| SQLReturnMissingFields |
TRUE |
| UploadAbortFlag |
0 (No abort) |
| SQLSelect |
“*” |
Upload (String sLocalPath,String sHostPath,String sFDFFile)
This method uploads a local file.
Parameters
String sLocalPath: Path of the local file (Ex : C:\mydir\myfile.txt)
String sHostPath: AS/400 Member path (Library/file(member))
String sFDFFile: If not empty, specifies the local path of the existing format description file associated with the local
file.
Return type
Public System.Booleanean: TRUE upon succeeding, FALSE otherwise
Note
In asynchronous mode, the methods returns immediately with TRUE.