MMScript

Trigger and schedule scripts

Functions

There are two ways to view the MMScript function reference, the Function Reference below, and the Function Reference Browser in a new window.

Function Reference

The Function Reference is a complete reference for MMScript functions. Click on a function title to view more information which includes the function description, parameter information, example usage and more.

Function Reference Browser

function_browser

The Function Reference Browser offers better navigation for the MMScript functions, you can Launch Function Browser in a new window.


Function Reference

  • MMScript_AreScriptEventsEnabled

    This function will return 1 if the plug-in is currently processing Script Events or 0 if not. You can use MMScript_DisableScriptEvents and MMScript_EnableScriptEvents to tell the plug-in to process... read more

  • MMScript_CancelScriptEvent

    Use this function to Cancel an existing Script... read more

  • MMScript_Configure

    Calling this function with no parameters will open the MMScript Configuration Dialog. You can optionally open to a specific tab by specifying the name of the tab as the "Option" parameter. This... read more

  • MMScript_CreateDateTimeScriptEvent

    Use this function to create a Script Event that occurs at a specific date and/or time in the... read more

  • MMScript_CreateIdleScriptEvent

    Use this function to create a Script Event that occurs after the user has been idle for a specific amount of time. A Repeating Idle Script Event will only occur once per idle state. In other words,... read more

  • MMScript_CreateImmediateScriptEvent

    Use this function to call a script immediately. This is useful for processing fields when a user leaves them or for calling a dynamically named... read more

  • MMScript_CreateIntervalScriptEvent

    Use this function to create a Script Event that occurs after a specified amount of time. This type of Script Event can also be repeating so that it will call your script every so many days, hours,... read more

  • MMScript_CreateXMLScriptEvent

    Use this function to create a Script Event using the older XML format. Each of the above functions allow you to create the same type of Script Events you can create with XML here, but if you prefer... read more

  • MMScript_DisableScriptEvents

    Use this function to tell the plug-in to stop processing Script... read more

  • MMScript_EnableScriptEvents

    Use this function to tell the plug-in to start processing Script Events again if you previously called... read more

  • MMScript_GetScriptEventName

    Use this function to retrieve the name of the Script Event that has called your script. This is useful if you have more than one Script Event calling the same... read more

  • MMScript_GetScriptEventValue

    Use this function to retrieve the Value you assigned to a Script Event. You can also get this Value with the Get(ScriptParameter) calculation function. The Value of a Script Event is useful for... read more

  • MMScript_IsUserIdle

    Use this function to determine if the user has been idle for at least a specific amount of... read more

  • MMScript_ListScriptEvents

    This function returns a list of all currently defined Script... read more

  • MMScript_Register

    You can use this function to Register the plug-in from a script instead of through the Configuration Dialog. This is useful when the plug-in is being distributed to many computers, allowing you to... read more

  • MMScript_ShellExecute

    Use this function to call a Command in the System's Command Line Interface. On Mac OS X, this is in the Unix Command Line. On Windows, this is in the DOS Command... read more

  • MMScript_UpdateScriptEventValue

    Use this function to Update the Value of an existing Script... read more

  • MMScript_Version

    This function returns the current version of MMScript. This function is useful for testing whether or not the plug-in is installed and enabled. If you call this function and a question mark ("?")... read more

  • MMScript_VersionAutoUpdate

    This function returns an Auto Update friendly Version number of MMScript. The format of this version number is always exactly 8 digits long. The first two digits represent the major version of the... read more

  • Reference: XML

    The <script> tag allows you to define script events for MMScript to call. You need to define at least the db and script attributes to have a valid <script> tag. This is an empty tag, so... read more