VeriStand .NET API Reference

FTPBase Members

The FTPBase type exposes the following members.

NameDescription
FTPBase
Overloaded. Initializes a new instance of the FTPBase class.

Methods

NameDescription
CheckForErrors Performs checks on a step and returns any errors, warnings, or messages that are relevant to the step's current configuration. (Overrides ActionStep.CheckForErrors().)
Clone Creates a new object that is a copy of the current instance. (Inherited from BaseNode.)
CreateUniqueFileName Creates a unique filename by appending a number to proposedFileName.
DoesFileExistOnFTPServer Checks if the specified file already exists on the FTP server.
DownloadFile Downloads the specified file from the FTP server and copies it to the Destination directory. This method uses a buffer of a size specified by BufferLength.
EqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
FinalizeAllows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetFileListFromDirectory Returns the name of all files from a directory on the FTP server. This method uses the proxy server settings, including ProxyUserName and ProxyPassword.
GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
GetTypeGets the Type of the current instance. (Inherited from Object.)
MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
ToStringReturns a String that represents the current Object. (Inherited from Object.)
UploadFile
Overloaded. Uploads a file to the FTP server.

Properties

NameDescription
BufferLength Gets or sets the size of the buffer, in bytes, to use for streaming data.
Description Gets or sets the description of the node that appears in the Property Browser when you select the node in the Stimulus Profile Editor. (Inherited from BaseNode.)
EnableProxy Gets or sets a value indicating whether to transmit data through a proxy server.
Filter Gets or sets a regular expression to use to filter files by filename when ServerURL is a folder.
Id Gets the unique identifier for a step, which is the full path to the step in the stimulus profile hierarchy. (Inherited from ActionStep.)
OverwriteExistingFileBehavior Gets or sets the action to take if a file of the same name already exists in the destination directory.
Password Gets or sets the password for UserName to use to access the FTP server.
ProxyPassword Gets or sets the password for ProxyUserName to use to access the proxy server.
ProxyPort Gets or sets the port the FTP proxy uses.
ProxyURL Gets or sets the URL of the proxy server.
ProxyUserName Gets or sets the username for the proxy server.
ResXKey Gets or sets the ResX key for the node, which is a pointer to a .resx file that contains a context help description for the node. (Inherited from BaseNode.)
ServerURL Gets or sets the address of a file or directory on the FTP server.
SSL Gets or sets a value indicating whether data transmission is encrypted using an SSL protocol.
State Gets the execution state of a step (Idle, Initializing, Running, and so on.) (Inherited from ActionStep.)
StepName Gets the name of a step. (Inherited from ActionStep.)
Timeout Gets or sets the time in seconds to wait for a response from the FTP server before returning a timeout error.
UseBinary Gets or sets a value indicating whether data is transmitted in binary form.
UsePassive Gets or sets a value indicating whether to use a passive or active connection on the FTP server.
UserName Gets or sets the username to use to access the FTP server.

Events

NameDescription
PropertyChanged Occurs when a property value changes. (Inherited from BaseNode.)

See Also

Log in to get a better experience