Macro Icon Properties

Macros are sections of code that can be used and reused in projects.

Old Versions

This page is current for Flowcode v9 and later. Earlier versions can be found below:

Flowcode v8

Details

→

→

Macros

Macros (explained here) are those designed and created by the user.

Macros can be exported and imported allowing users to build up macro libraries of common or important tasks.

On Macros the outer bands are clear and not hatched.

The macro properties dialog allows users to select and create macros.

Adding a Macro

Select the Macro to use from the list, or click on Create new macro to begin creating a new macro to add to the list.

Add in any parameters required, and select a return value if required.

Clicking on the OK button completes the process and closes the dialog.

Clicking on the OK and edit button completes the process, closes the dialog and opens the selected macro for editing.

Parameters

If the device macro requires any parameters then these can be entered in this field. They can be numeric values or existing variables. Clicking on the down arrow allows you to select an existing variable or to create a new one.

The parameter details will list the parameter type. Parameters must be of the required type to be accepted.

Note that a full set of parameters must be provided.

Return value

If the device macro returns a value then you can assign that value to an existing variable for use later in the flowchart. If the function returns a value but you do not wish to retrieve it then leave this field empty.

The variable type of the return value will be listed. A variable of the specified type must be used to accept the return value.

Create New Macro button

Select this button to create a new macro within the flowchart.

OK & Edit Macro button

Clicking this button will open up the chosen macro to allow it to be viewed or edited.

Macro types

Macros are 3 types of macro that can be called using this command icon:

Macros	Macros designed and created by the user that are created as part of this project.
Components	Pre-defined macros supplied with the components. Only components that have been added to this project are available.
Built-in Functions	Simulation-only macros for advanced Flowcode use such as component creation.

Video

See the Macros video to learn how to call a macro from a selection of existing macros and input a macro parameter using the Macro icon.

{{#ev:youtube|SlWkK1mwyJQ|640}}