Add a Function

Declares a new function. A Function procedure is a series of steps enclosed by the Function and End Function actions. The Function procedure performs a task and then returns control to the calling macro or function. When it returns control, it also returns a value to the calling macro or function. Each time the procedure is called, its steps run, starting with the first executable step after the Function statement and ending with the first End Function, or Exit Function action encountered.

Parameters

Function name Specifies the function name.
Parameters list Specifies the parameters list for this function. The parameters are used for passing the data into the function. You can define a function with no parameters, one parameter, or more than one, but to use a call to that function with arguments you must take into consideration what is defined.
Description Specifies a comment for the function.

Function Arguments

There are three parameter type:

General Passes a value into the function.
Variable reference Passes a variable into the function. The function can read or set the value of the variable. Passing a value will cause an error occurring.
Object Passes a Webpage, Excel doucment, FTP, or Dataset into the function. So that the function can read or write the content of the document.

This parameter is optional With this option checked, the parameter is optional, and you need to assign a default parameter value. The optional parameters can be omitted when the function is called.

Returning value

The value a Function procedure sends back to the calling macro or function is called its return value. The procedure returns this value in the action "Exit Function".

Introduction
Editions Comparison
Minimum Requirements
Uninstalling
Using Macro Expert
- Getting Started
- Macro Manager
- Options
- Script Editor
  - Looking at Script Editor
  - Editing a macro
  - Working with the variables
  - Attachments
  - Debugging a macro
  - Options
    - General
    - Hotkeys
    - View
    - Debugging
    - Internal Browser
Macro Properties
- General
- Parameters for Playback
- Triggers
- Schedulers
- Advanced Options
Internal (built-in) Functions
Macro Commands
- General Settings and Error Handling Options
- Keyboard and Mouse
  - Key Action
  - Mouse Action
  - Put Text
  - Series Keystrokes
  - Mouse Move Activity
  - Change Options of Mouse Actions
  - Save Cursor Position for Restoring
  - Reset Keyboard
- UI Object
  - Mouse Action on UI Object
  - Read Property of UI Object
  - Read Property of UI Object From Point
  - Carry out Action on UI Object
  - Set Text of UI Object
- Dialog
  - Display Message Dialog
  - Select a Folder
  - File-selection Dialog
  - Input Dialog
  - Advanced Input Dialog
  - Show Tip Text
  - Hide Tip text
  - Choice Dialog
- Window
  - Window Action
  - Keep Window's State
  - Show or Hide Windows on Desktop
- Wait
  - Delay
  - Wait for Mouse Pointer
  - Wait for Window
  - Wait for Color
  - Wait for UI Object
  - Wait for Keystroke
  - Wait for Mouse Action
  - Wait for Image
  - Wait for File
  - Wait for Process
  - Wait for Expression
- Play Control
  - On Error
  - Pause
  - Stop
  - End
  - Play Speed
  - Play a Macro
  - Call Builtin Function
  - Set Emulation Level
  - Block/unblock Mouse and Keyboard
  - Log a Playback Message
  - Redirect Play Log
  - Control Running Macros
  - Set Monitor Window
  - Change Text On Monitor Window
  - Redirect Keyboard/Mouse Actions
- Custom Functions
  - Add a Function
  - Call Function
  - Exit Function
  - Import Functions Library
- Variable
  - Set Variable Value
  - Increase/Decrease Value
  - Advanced Set Variable Value
  - Advanced Get Variable Value
  - Swap Two Variables
  - Redefine Variable
  - Fill Array
  - Add an Element to Array
  - Delete an Element From Array
  - Sort all Elements in Array
  - Clone an Array
  - Search for Element in Array
  - Dump/Restore Value of User Variables
- Text
  - Find Text
  - Replace Text
  - Convert Text
  - Split Text
  - Pad Text
  - Get Sub Text
  - Extract Text
  - Trim Text
  - Get Text Length
  - Append Text
  - Fomat Datetime
  - Generate Random Text
- Flow
  - Comments
  - Separator line
  - Label
  - Goto
  - If Expression
  - If Variable
  - If Color
  - If File Exists
  - If Window Exists
  - If Image
  - If UI Object
  - If Webpage Element
  - Select Case
- Loop
  - Loop
  - Loop Array
  - Loop Windows
  - Loop Files
  - Loop Processes
  - Loop Text
  - Loop Microsoft Excel
  - Loop Dataset
  - Loop Elements of Webpage
  - Exit/Continue Loop
- System
  - Run
  - Print a Document
  - Image Search
  - Text Search Based on Image
  - Capture Screenshot
  - Read/Write INI File
  - Generate Random Number
  - End Process
  - Get Pixel
  - Get Caret (Text Cursor) Position
  - Set System Date and Time
  - Registry Operation
  - Call an External DLL
  - Send Message to Window
- Session
  - Log off
  - Start Screen-Saver
  - Lock Workstation
  - Shut-down Computer
  - Turn Off/On Display
- Clipboard
  - Copy, Cut, Paste and Clear
  - Put Data to Clipboard
  - Get Data From Clipboard
- Multimedia
  - Play an Audio
  - Increase/Decrease Volume
  - Adjust Volume
  - Sound Switch
  - Sound On/Off
  - CD Player
- Webpage
  - Open a Web page
  - Connect a Opened Webpage
  - Read Field
  - Fill Field
  - Save Image Element
  - Click Element
  - On Popup Window on Webpage
  - Submit Form
  - Find Element
  - Wait for Element
  - Close Webpage
  - Save Webpage Content
  - Save Webpage Cookies
  - Internet Explorer Navigation Actions
  - Change Window of Webpage
- Network
  - Make Remote Access Connection
  - Disconnect Remote Access Connection
  - Connect Network Resource
  - Disonnect Network Resource
- Internet
  - Send Email
  - Fetch Email
  - Delete Email
  - HTTP Download
  - HTTP Post
  - HTTP Get
  - Ping
  - Retrieve Internet Time
  - Delete Tempoary Internet Files
  - Delete Internet Explorer Cookies
  - Clear Internet Explorer History
- FTP
  - Log On
  - Connect Session in Parent
  - Log Off/Disconnect
  - Download
  - Upload
  - Create Folder
  - Delete Folder
  - Get Current Path
  - Change Current Path
  - Delete Files
  - List Files
  - Rename
  - Move Files
  - Move Folder
  - FTP Command
- File
  - Copy Files
  - Move Files
  - Delete Files
  - Create a Folder
  - Delete a Folder
  - Rename Files
  - Set File Attributes
  - Change File Time
  - Synchronize Folders
  - Compress Files
  - Extract a Zipped File
  - Read Text File
  - Write Text File
  - Load Binary File
  - Write Binary File
  - Find/Replace in File
  - Get File Attributes
- Image
  - Resize Image
  - Clip Image
  - Convert Image Forma
- Microsoft Excel Document
  - Open Document
  - Create a Microsoft Excel Document
  - Connect Open Document
  - Close Document
  - Save Document
  - Run Macro in Document
  - Read a Cell
  - Read Multiple Cells
  - Write Cell
  - Write Array to Cell
  - Insert Excel Cells
  - Delete Excel Cells
  - Find Cell
  - Change Color of Cell
  - Add Worksheet
  - Delete Worksheet
  - Activate Worksheet
  - Wait for Cell
- Database
  - Connect to Data Source
  - Close Data Source Connection
  - Execute SQL Statement
  - Connect Dataset in Parent
  - Close Dataset
  - Set Field Value
  - Get Field Value
  - Get Multi-fields' Value
  - Change Current Record Position
  - Transaction on Data Source
Variables and Expressions
Command Line Usage
Frequent Question and Answer
Purchasing Macro Expert

Mailing List

Subscribe to our newsletter and receive updates, tips and tricks on how to automate your tasks with Macro Expert.

Add a Function

Parameters

Function Arguments

Returning value

See Also:

Resources & Support

Websites

About

Mailing List