|
|
|
|
procedure Connect
(const objectName : array of char;
const FtpServerName : array of char;
const userID : array of char;
const Password : array of char;
var Success : boolean); overload; stdcall;
exports Connect (const objectName : array of char;
const FtpServerName : array of char;
const userID : array of char;
const Password : array of char;
var Success : boolean) name 'ObjFtp_Connect';
//*
// Connect - Connect to the remote ftp server. (Requires SageST_Objects.dll).
//
//
// This procedure will connect to the remote ftp server. This is
// required before any of the file actions can take place. Once
// all file transfers or operations with the ftp server are complete
// the disconnect routine should be called.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName, FtpServerName, UserID and Password or the routine
// will fail.
//
// When logging into an anonymous Ftp server the UserID must be set
// to the value 'Anonymous' and the password will be the email address
// of the sender. Please note that the UserID is almost always case
// sensitive so when it is anonymous it must be spelled 'Anonymous'.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// Connect (ObjectName, FtpServerName, UserID, Password, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// FtpServerName : array of char
// The name of the FTP server to connect to. An IP address may also be used.
//
// UserID : array of char
// The ID of the user logging into the Ftp server.
//
// Password : array of char
// The password of the user logging into the Ftp server.
//
// EXIT -
//
// Success : boolean
// True - Connection was made.
// False - Some problem prevented the connection.
//
// EXAMPLE -
//
// ObjFtp.Connect ('MYFTP',
// 'some.good.server',
// 'abc',
// 'pass@word23',
// Success);
//
procedure Connect
(const objectName : string;
const FtpServerName : string;
const userID : string;
const Password : string;
var Success : boolean); overload; stdcall;
exports Connect (const objectName : string;
const FtpServerName : string;
const userID : string;
const Password : string;
var Success : boolean) name 'ObjFtp_STRConnect';
//*
// STRConnect - See documentation of Connect.
//
procedure Disconnect
(const objectName : array of char;
var Success : boolean); overload; stdcall;
exports Disconnect (const objectName : array of char;
var Success : boolean) name 'ObjFtp_Disconnect';
//*
// Disconnect - Disconnect from the remote ftp server. (Requires SageST_Objects.dll).
//
//
// This procedure will disconnect from the remote ftp server. This is
// required after completing all file actions.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// Disconnect (ObjectName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// EXIT -
//
// Success : boolean
// True - Disconnection completed.
// False - Some problem prevented the disconnection.
//
// EXAMPLE -
//
// ObjFtp.Disconnect ('MYFTP',
// Success);
//
procedure Disconnect
(const objectName : string;
var Success : boolean); overload; stdcall;
exports Disconnect (const objectName : string;
var Success : boolean) name 'ObjFtp_STRDisconnect';
//*
// STRDisconnect - See documentation of Disconnect.
//
procedure PutFile
(const objectName : array of char;
const LocalFileName : array of char;
const RemoteFileName : array of char;
var Success : boolean); overload; stdcall;
exports PutFile (const objectName : array of char;
const LocalFileName : array of char;
const RemoteFileName : array of char;
var Success : boolean) name 'ObjFtp_PutFile';
//*
// PutFile - Put file from local to remote machine. (Requires SageST_Objects.dll).
//
//
// This procedure will ftp a file from the local to a remote machine.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName, LocalFileName and RemoteFileName or the routine
// will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// PutFile (ObjectName, LocalFileName, RemoteFileName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// LocalFileName : array of char
// The name of the file being sent. This may include a path but
// is not necessary. If a path is not provided it will use the
// local directory.
//
// RemoteFileName : array of char
// The name of the file when it reaches the remote server. This
// may include a path but is not necessary. If a path is not
// provided it will use the local directory. By putting a different
// name here you can change the name of the file as it is transferred.
//
// EXIT -
//
// Success : boolean
// True - File was uploaded successfully.
// False - Some problem prevented the file from being sent.
//
// EXAMPLE -
//
// ObjFtp.PutFile ('MYFTP',
// 'E:\LocalDir\TestFile.doc',
// '/remotedir/TestFile.out',
// Success);
//
procedure PutFile
(const objectName : string;
const LocalFileName : string;
const RemoteFileName : string;
var Success : boolean); overload; stdcall;
exports PutFile (const objectName : string;
const LocalFileName : string;
const RemoteFileName : string;
var Success : boolean) name 'ObjFtp_STRPutFile';
//*
// STRPutFile - See documentation of PutFile.
//
procedure GetFile
(const objectName : array of char;
const RemoteFileName : array of char;
const LocalFileName : array of char;
var Success : boolean); overload; stdcall;
exports GetFile (const objectName : array of char;
const RemoteFileName : array of char;
const LocalFileName : array of char;
var Success : boolean) name 'ObjFtp_GetFile';
//*
// GetFile - Get a file from remote to local machine. (Requires SageST_Objects.dll).
//
//
// This procedure will ftp a file from the remote to a local machine.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName, RemoteFileName and LocalFileName or the routine
// will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// GetFile (ObjectName, RemoteFileName, LocalFileName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// RemoteFileName : array of char
// The name of the file that is on the remote server. This
// may include a path but is not necessary. If a path is not
// provided it will use the local directory.
//
// LocalFileName : array of char
// The name of the file being received. This may include a path but
// is not necessary. If a path is not provided it will use the
// local directory. By putting a different name here you can change
// the name of the file as it is transferred.
//
// EXIT -
//
// Success : boolean
// True - File was downloaded successfully.
// False - Some problem prevented the file from being received.
//
// EXAMPLE -
//
// ObjFtp.PutFile ('MYFTP',
// '/remotedir/TestFile.out',
// 'E:\LocalDir\TestFile.doc',
// Success);
//
procedure GetFile
(const objectName : string;
const RemoteFileName : string;
const LocalFileName : string;
var Success : boolean); overload; stdcall;
exports GetFile (const objectName : string;
const RemoteFileName : string;
const LocalFileName : string;
var Success : boolean) name 'ObjFtp_STRGetFile';
//*
// STRGetFile - See documentation of GetFile.
//
procedure DeleteFile
(const objectName : array of char;
const RemoteFileName : array of char;
var Success : boolean); overload; stdcall;
exports DeleteFile (const objectName : array of char;
const RemoteFileName : array of char;
var Success : boolean) name 'ObjFtp_DeleteFile';
//*
// DeleteFile - Delete a file from the remote machine. (Requires SageST_Objects.dll).
//
//
// This procedure will delete a file on a remote machine using ftp.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName and RemoteFileName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// DeleteFile (ObjectName, RemoteFileName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// RemoteFileName : array of char
// The name of the file that is on the remote server. This
// may include a path but is not necessary. If a path is not
// provided it will use the local directory.
//
// EXIT -
//
// Success : boolean
// True - File was deleted successfully.
// False - Some problem prevented the file from being deleted.
//
// EXAMPLE -
//
// ObjFtp.DeleteFile ('MYFTP',
// '/remotedir/TestFile.out',
// Success);
//
procedure DeleteFile
(const objectName : string;
const RemoteFileName : string;
var Success : boolean); overload; stdcall;
exports DeleteFile (const objectName : string;
const RemoteFileName : string;
var Success : boolean) name 'ObjFtp_STRDeleteFile';
//*
// STRDeleteFile - See documentation of DeleteFile.
//
procedure RenameFile
(const objectName : array of char;
const RemoteFileName1 : array of char;
const RemoteFileName2 : array of char;
var Success : boolean); overload; stdcall;
exports RenameFile (const objectName : array of char;
const RemoteFileName1 : array of char;
const RemoteFileName2 : array of char;
var Success : boolean) name 'ObjFtp_RenameFile';
//*
// RenameFile - Rename a file on the remote machine. (Requires SageST_Objects.dll).
//
//
// This procedure will rename a file on a remote machine using ftp.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName, RemoteFileName1 and RemoteFileName2 or the routine
// will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// RenameFile (ObjectName, RemoteFileName1, RemoteFileName2, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// RemoteFileName1 : array of char
// The name of the file that is now on the remote server. This
// may include a path but is not necessary. If a path is not
// provided it will use the local directory.
//
// RemoteFileName2 : array of char
// The new name for the file on the remote server. This
// may include a path but is not necessary. If a path is not
// provided it will use the local directory.
//
// EXIT -
//
// Success : boolean
// True - File was renamed successfully.
// False - Some problem prevented the file from being renamed.
//
// EXAMPLE -
//
// ObjFtp.RenameFile ('MYFTP',
// '/remotedir/TestFile.out',
// '/remotedir/NewName.out',
// Success);
//
procedure RenameFile
(const objectName : string;
const RemoteFileName1 : string;
const RemoteFileName2 : string;
var Success : boolean); overload; stdcall;
exports RenameFile (const objectName : string;
const RemoteFileName1 : string;
const RemoteFileName2 : string;
var Success : boolean) name 'ObjFtp_STRRenameFile';
//*
// STRRenameFile - See documentation of RenameFile.
//
procedure MakeDirectory
(const objectName : array of char;
const RemoteDirName : array of char;
var Success : boolean); overload; stdcall;
exports MakeDirectory (const objectName : array of char;
const RemoteDirName : array of char;
var Success : boolean) name 'ObjFtp_MakeDirectory';
//*
// MakeDirectory - Make a directory on the remote machine. (Requires SageST_Objects.dll).
//
//
// This procedure will make a new directory on the remote machine
// using ftp.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName and RemoteDirName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// MakeDirectory (ObjectName, RemoteDirName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// RemoteDirName : array of char
// The name of the directory to make.
//
// EXIT -
//
// Success : boolean
// True - Directory was created successfully.
// False - Some problem prevented the directory from being created.
// This can include the fact that the directory already existed.
//
// EXAMPLE -
//
// ObjFtp.MakeDirectory ('MYFTP',
// '/newremotedir',
// Success);
//
procedure MakeDirectory
(const objectName : string;
const RemoteDirName : string;
var Success : boolean); overload; stdcall;
exports MakeDirectory (const objectName : string;
const RemoteDirName : string;
var Success : boolean) name 'ObjFtp_STRMakeDirectory';
//*
// STRMakeDirectory - See documentation of MakeDirectory.
//
procedure ChangeDirectory
(const objectName : array of char;
const RemoteDirName : array of char;
var Success : boolean); overload; stdcall;
exports ChangeDirectory (const objectName : array of char;
const RemoteDirName : array of char;
var Success : boolean) name 'ObjFtp_ChangeDirectory';
//*
// ChangeDirectory - Change current working directory on remote machine. (Requires SageST_Objects.dll).
//
//
// This procedure will change the current working directory on a
// remote ftp server.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName and RemoteDirName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// ChangeDirectory (ObjectName, RemoteDirName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// RemoteDirName : array of char
// The name of the directory to change to.
//
// EXIT -
//
// Success : boolean
// True - Directory was changed successfully.
// False - Some problem prevented the directory from being changed.
//
// EXAMPLE -
//
// ObjFtp.ChangeDirectory ('MYFTP',
// '/newremotedir',
// Success);
//
procedure ChangeDirectory
(const objectName : string;
const RemoteDirName : string;
var Success : boolean); overload; stdcall;
exports ChangeDirectory (const objectName : string;
const RemoteDirName : string;
var Success : boolean) name 'ObjFtp_STRChangeDirectory';
//*
// STRChangeDirectory - See documentation of ChangeDirectory.
//
procedure RemoveDirectory
(const objectName : array of char;
const RemoteDirName : array of char;
var Success : boolean); overload; stdcall;
exports RemoveDirectory (const objectName : array of char;
const RemoteDirName : array of char;
var Success : boolean) name 'ObjFtp_RemoveDirectory';
//*
// RemoveDirectory - Remove a directory on remote machine. (Requires SageST_Objects.dll).
//
//
// This procedure will remove a directory on a remote ftp server.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName and RemoteDirName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// RemoveDirectory (ObjectName, RemoteDirName, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// RemoteDirName : array of char
// The name of the directory to remove.
//
// EXIT -
//
// Success : boolean
// True - Directory was removed successfully.
// False - Some problem prevented the directory from being removed.
// This can include the fact that the directory was not empty.
//
// EXAMPLE -
//
// ObjFtp.RemoveDirectory ('MYFTP',
// '/oldremotedir',
// Success);
//
procedure RemoveDirectory
(const objectName : string;
const RemoteDirName : string;
var Success : boolean); overload; stdcall;
exports RemoveDirectory (const objectName : string;
const RemoteDirName : string;
var Success : boolean) name 'ObjFtp_STRRemoveDirectory';
//*
// STRRemoveDirectory - See documentation of RemoveDirectory.
//
procedure ListCurrentRemoteDirectory
(const objectName : array of char;
const TypeOfList : ListType;
const ListCriteria : array of char;
const ListProc : ListProcType;
var Success : boolean); overload; stdcall;
exports ListCurrentRemoteDirectory (const objectName : array of char;
const TypeOfList : ListType;
const ListCriteria : array of char;
const ListProc : ListProcType;
var Success : boolean) name 'ObjFtp_ListCurrentRemoteDirectory';
//*
// ListCurrentRemoteDirectory - List contents of directory (Requires SageST_Objects.dll).
//
//
// This procedure will list the contents of the current remote directory
// on an ftp server. The results come back one at a time to the ListProc
// in a record structure. Inside the proc you can perform actions on the
// file such as rename, get or delete. You can restrict the number of
// names that are returned to you by using the ListCriteria entry.
// Wildcard characters are allowed so you can ask for list that are
// restricted to something like all '*.dat' files. If you want to see the
// entire contents of the directory then you should use '*.*' as the
// criteria.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName and ListCriteria or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// ListCurrentRemoteDirectory (ObjectName, TypeOfList, ListCriteria,
// ListProc, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// TypeOfList : ListType
// Determines the amount of information to be returned in the callback
// routine. NameOnlyList returns just the name found. AllDataList
// returns other information such as the date and time, size and
// possibly the attributes of the file. The format of the line and the
// layout of the information is totally dependent upon the server you are
// connected to.
//
// ListCriteria : array of char
// The criteria to use for matching names to return. If the TypeOfList
// requested is AllDataList this parameter will become *.* no matter what
// you pass in since I don't know what format is used by the server you are
// connected to and hence can't parse the name out. If you use NameOnlyList
// for the type then I will check it against this wildcard.
//
// ListProc : ListProcType
// The routine to call back with a matching name.
//
// EXIT -
//
// Success : boolean
// True - List of any matching names was returned.
// False - Some problem prevented the list from being returned.
//
// EXAMPLE -
//
// ObjFtp.ListCurrentRemoteDirectory ('MYFTP',
// ObjFtp.AllDataList,
// '*.*',
// MyListProc,
// Success);
//
procedure ListCurrentRemoteDirectory
(const objectName : string;
const TypeOfList : ListType;
const ListCriteria : string;
const ListProc : ListProcType;
var Success : boolean); overload; stdcall;
exports ListCurrentRemoteDirectory (const objectName : string;
const TypeOfList : ListType;
const ListCriteria : string;
const ListProc : ListProcType;
var Success : boolean) name 'ObjFtp_STRListCurrentRemoteDirectory';
//*
// STRListCurrentRemoteDirectory - See documentation of ListCurrentRemoteDirectory.
//
procedure SetMode
(const objectName : array of char;
const NewMode : ModeType;
var Success : boolean); overload; stdcall;
exports SetMode (const objectName : array of char;
const NewMode : ModeType;
var Success : boolean) name 'ObjFtp_SetMode';
//*
// SetMode - Set the mode of transfer to Ascii or Binary (Requires SageST_Objects.dll).
//
//
// This procedure will set the mode of subsequent transfers. The choices
// are between an Ascii mode or Binary mode. Once set this will be the mode
// used until it is changed or until the Disconnect routine is called. After
// disconnecting and reconnecting the mode will be reset to the default.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// SetMode (ObjectName, NewMode, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// NewMode : ModeType
// The mode used for file transfers (Ascii or Binary)
//
// EXIT -
//
// Success : boolean
// True - The mode was changed to the requested type.
// False - Some problem prevented the mode from being set.
//
// EXAMPLE -
//
// ObjFtp.SetMode ('MYFTP',
// ObjFtp.AsciiType,
// Success);
//
procedure SetMode
(const objectName : string;
const NewMode : ModeType;
var Success : boolean); overload; stdcall;
exports SetMode (const objectName : string;
const NewMode : ModeType;
var Success : boolean) name 'ObjFtp_STRSetMode';
//*
// STRSetMode - See documentation of SetMode.
//
procedure SetLogStatus
(const objectName : array of char;
const LogActive : boolean;
var Success : boolean); overload; stdcall;
exports SetLogStatus (const objectName : array of char;
const LogActive : boolean;
var Success : boolean) name 'ObjFtp_SetLogStatus';
//*
// SetLogStatus - Set whether a log prints during the FTP calls. (Requires SageST_Objects.dll).
//
//
// This procedure sets the status of whether a log of the FTP commands is printed
// during processing. If active the log will be a file called FTPCMDS.LOG. This will
// have entries that let you trace the workings of the various FTP calls. The
// default value is for the log to NOT be active.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// SetLogStatus (ObjectName, LogActive, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// LogActive : boolean
// True - A log file will be generated by the commands.
// False - No log file will be generated by the commands.
//
// EXIT -
//
// Success : boolean
// True - The log status was set.
// False - Some problem prevented the log status from being set.
//
// EXAMPLE -
//
// ObjFtp.SetLogStatus ('MYFTP',
// True,
// Success);
//
procedure SetLogStatus
(const objectName : string;
const LogActive : boolean;
var Success : boolean); overload; stdcall;
exports SetLogStatus (const objectName : string;
const LogActive : boolean;
var Success : boolean) name 'ObjFtp_STRSetLogStatus';
//*
// STRSetLogStatus - See documentation of SetLogStatus.
//
procedure GetCurrentDirectoryName
(const objectName : array of char;
var Directory : array of char;
var Success : boolean); overload; stdcall;
exports GetCurrentDirectoryName (const objectName : array of char;
var Directory : array of char;
var Success : boolean) name 'ObjFtp_GetCurrentDirectoryName';
//*
// GetCurrentDirectoryName - Gets the name of the current remote directory. (Requires SageST_Objects.dll).
//
//
// This procedure gets the name of the current directory on the
// remote Ftp server.
//
// Special note - This routine may give varying results. On one server
// that this was tested on the first time this routine was called the
// return value was '/' which would be the directory where it first
// connected. However after changing to another directory and then
// changing back to the starting directory it returned '/MainDir'
// although it was in the same directory.
//
// NOTE - If you define an FTP object in Thor and want to call
// it from this package then you MUST have SageST_Objects.dll
// in the directory with the program .EXE file or in the system's
// search path. Also the DFL containing the object must be open.
//
// Also note that the absolue minimum that you must pass is the
// ObjectName or the routine will fail.
//
// Please note that many servers will be Unix based and all UserID's,
// passwords and filenames will be case sensitive. You MUST have an
// understanding of the requirements for names for this routine to
// succeed.
//
// CALLING SEQUENCE -
//
// GetCurrentDirectoryName (ObjectName, Directory, Success)
//
// ENTRY -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// EXIT -
//
// ObjectName : array of char
// The name given the object when declared in Thor.
//
// Success : boolean
// True - The directory name was retrieved.
// False - Some problem prevented the retrieval of the directory name.
//
// EXAMPLE -
//
// ObjFtp.GetCurrentDirectoryName ('MYFTP',
// DirectoryName,
// Success);
//
procedure GetCurrentDirectoryName
(const objectName : string;
var Directory : string;
var Success : boolean); overload; stdcall;
exports GetCurrentDirectoryName (const objectName : string;
var Directory : string;
var Success : boolean) name 'ObjFtp_STRGetCurrentDirectoryName';
//*
// STRGetCurrentDirectoryName - See documentation of GetCurrentDirectoryName.
//
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance