Ftp_ReceiveString


Downloads a text string from a remote server using FTP (File Transfer Protocol).

Syntax

C++
Python
 
def Ftp_ReceiveString(
	inHostName: str,
	inFtpFilePath: str,
	/,
	*,
	inUsername: str | None = None,
	inPassword: str | None = None,
	inUsePassiveMode: bool = False,
	inTimeout: int | None = None,
	inAllowUntrusted: bool = False,
	inCaCertFile: str | None = None
)
-> outText: str

Parameters

Name Type Range Default Description
Input value inHostName str URL address of the remote server.
Input value inFtpFilePath str Location of the file on a remote server.
Input value inUsername str | None None User name needed to log in.
Input value inPassword str | None None Password associated with a user name.
Input value inUsePassiveMode bool False Protocol communication mode. May be necessary when using a firewall.
Input value inTimeout int | None 0 - None Request timeout in seconds.
Input value inAllowUntrusted bool False Whether or not to allow untrusted SSL certificates.
Input value inCaCertFile str | None None File holding one or more certificates to verify the peer with.
Output value outText str Text read from a remote server.