CuteFTP Professional User s Guide 

S

CRIPT CONVENTIONS FOR EXAMPLES

The examples in this guide use the following conventions: 

maroon

text

 is used for the syntax of a method or property 

"Bold font in double quotes" display parameters for a method or property 

red text

 indicates the method or property within an example script 

  (apostrophe or single quote mark) shows comments that do not affect the script 

[Square brackets] are a place for optional items. You should enter the option, but not 

the brackets.  Here s an example: 

The syntax says;  

String Object.Option("[option name]") = true | false 

Enter it into a program like this: 

MySite.Option("FilterDirs")=False 

M

ETHODS

, 

PROPERTIES AND WILDCARDS OVERVIEW

Use methods and properties to operate the Transfer Engine. Methods and properties are 

defined below.  

Methods 

A method can be described as a command or function that may accept arguments 

(parameters) and may return a certain type of value.  

Example  

Boolean Object.LocalExists(BSTR bstrName);  

For this method, the type of the return value is Boolean. The command accepts an argument 

as a string value, here shown as BSTR (the type) and bstrName (a place holder for the 

argument).  

In a program, you can execute a method and assign the return value to a variable all in one 

command.  

Example  

Exists = MySite.LocalExists "c:\temp\file.txt"  

The argument "c:\temp\file.txt exists" is passed to the method LocalExists as a string 

(reason for the quotes). The variable Exists is then populated with a 1 or a 0 which is, in 

essence, true or false. You can then perform actions in your script based on those results.  

Properties 

A property is simply an attribute of a function (another word for method) or object internal 

to the TE framework. All properties have default values. Methods that rely on these 

properties will use default values unless you specify otherwise.  

164