Onetastic Macro Documentation > Concepts > Functions

Functions

Functions in macros are similar to the same concept in other programming languages. They take one or more parameters and return a single value (or no value). They can be used to retrieve objects, manipulate strings, dates, arrays, create and display dialog boxes and control the macro execution.

Following is an example usage of String_Length and GetCurrentPage functions to obtain the length of the title of the current page:

Below is the list of all available built-in functions:

• Array Functions
• Color Functions
• Data Store Functions
• Date/Time Functions
• Dialog Box Functions
• Macro Execution Functions
• Object Functions
• String Functions

User Defined Functions

You can also define your own functions with parameters and return value. You can decide whether the paremeters are passed by reference or by value using the byref keyword. For pass-by-value, a copy of the argument is passed as the parameter. For pass-by-reference, a reference to the argument is passed and the function can modify the caller's argument. Objects are always passed by reference regardless of whether the parameter was decorated by byref or not.

// Function takes a page and adds the images in this page in the byref parameters // It returns a Bool indicating whether it found any images or not Function GetImagesInPage($page, byref $imagesInOutline, byref $imagesOnPage) $images = QueryObjects("Image", $page) ForEach ($image in $images) If (GetParentOfType($image, "Page", $parentPage)) Array_PushBack($imagesInOutline, $image) Else Array_PushBack($imagesOnPage, $image) Return Array_Length($images) > 0

// Get images in the current page $imagesInOutline = Array() $imagesOnPage = Array() If (GetImagesInPage(GetCurrentPage(), $imagesInOutline, $imagesOnPage)) // We found some images...