Idle Call - Revision history

Admin at 21:46, 3 April 2012

2012-04-03T21:46:29Z

Admin at 21:11, 3 April 2012

2012-04-03T21:11:58Z

Admin at 21:04, 3 April 2012

2012-04-03T21:04:26Z

Admin at 21:04, 3 April 2012

2012-04-03T21:04:10Z

Admin: New page: You can have FileMaker call your plugin during the standard system idle call. During this time, you can execute call backs to FileMaker, including Script and/or SQL callbacks. NOTE : B...

2012-04-03T20:57:03Z

New page: You can have FileMaker call your plugin during the standard system idle call. During this time, you can execute call backs to FileMaker, including Script and/or SQL callbacks. NOTE : B...

New page

You can have FileMaker call your plugin during the standard system idle call. During this time, you can execute call backs to FileMaker, including Script and/or SQL callbacks.

NOTE : Be careful that your idle code doesn't take too much time - it's called frequently and any time it takes reduces the overall performance of FileMaker.

===Step One - Enable Idle Time Flag===
Set the 'Want idle time' flag in the plugin Option String to be 'Y' (the third to last flag)

#define IDMA_Plugin_OptionString "IDMA1nnYYnn"
// ^--^ || | |---- // No Win32s support
// | || |------ // Want idle time
// | ||-------- // No old external functions
// | |--------- // Has preferences dialog
// |-------------- // 'IDMA' plug-in ID

@@ Line 35: / Line 35: @@
   		case kFMXT_Init:
+  		{
-  			//	Msg	=					Parm1						Parm2							Parm3
+  			//	Msg	=	Parm1				Parm2				Parm3
-  			//	kFMXT_Init				FMX_Application value		App vers unicode c str* 		[unused]
+  			//	kFMXT_Init	FMX_Application value		App vers unicode c str* 	[unused]
   			gFMX_ExternCallPtr->result = Do_PluginInit(gFMX_ExternCallPtr->extnVersion, gFMX_ExternCallPtr->parm1 );
+  		}
@@ Line 43: / Line 43: @@
   		case kFMXT_Idle:
+  		{
-  			Do_PluginIdle(gFMX_ExternCallPtr->parm1);
+  			Do_PluginIdle(gFMX_ExternCallPtr->parm1);		// This calls our 'idle' function, passing the current 'idleLevel'
+  		}
   		break;
@@ Line 61: / Line 61: @@
   		case kFMXT_GetString:
+  		{
-  			Do_GetString(gFMX_ExternCallPtr->parm1, gFMX_ExternCallPtr->parm2,
+  			Do_GetString(gFMX_ExternCallPtr->parm1, gFMX_ExternCallPtr->parm2, gFMX_ExternCallPtr->parm3, reinterpret_cast<FMX_Unichar*>(gFMX_ExternCallPtr->result));
+  		}
   		break;
@@ Line 79: / Line 78: @@
   static void Do_PluginIdle(FMX_IdleLevel idleLevel)
+  {
-  	if (pluginIsRunningOnFMPro)          // Only execute if running on client or runtime  (ie. don't call when on server)
+  	if (pluginIsRunningOnFMPro)		// Only execute if running on client or runtime  (ie. don't call when on server)
-  	{                                                    // BOOL pluginIsRunningOnFMPro  set during plugin init
+  	{					// BOOL pluginIsRunningOnFMPro  set during plugin init
   		// Check idle state
   		switch (idleLevel)
@@ Line 121: / Line 120: @@
-===Example 1 : Execute queued SQL===
+===Example : Execute queued SQL===
-The following example shows how to execute a callback to FileMaker of a queued ExecuteSQL
+The following example shows how to first get the current environment and then call a function 'sqlProcessQueue'.  This is done during 'safe' idle calls (UserIdle, NotIdle, ScriptPaused and ScriptRunning)

@@ Line 20: / Line 20: @@
-===Step Two - Do_PluginIdle function===
+===Step Two - FMExternCallProc===
 In your main file, you will find the 'Do_PluginIdle' function.
@@ Line 64: / Line 117: @@
+  	}
   } // Do_PluginIdle

@@ Line 43: / Line 43: @@
   			break;
-			case kFMXT_ScriptPaused:
+ 			case kFMXT_ScriptPaused:
+  			{
   				// The user is running a script that is paused

← Older revision		Revision as of 21:04, 3 April 2012
Line 15:		Line 15:
	// \| \|--------- // Has preferences dialog		// \| \|--------- // Has preferences dialog
	// \|-------------- // 'IDMA' plug-in ID		// \|-------------- // 'IDMA' plug-in ID
		+
		+
		+
		+
		+
		+	===Step Two - Do_PluginIdle function===
		+	In your main file, you will find the 'Do_PluginIdle' function.
		+
		+
		+	static void Do_PluginIdle(FMX_IdleLevel idleLevel)
		+	{
		+	if (pluginIsRunningOnFMPro) // Only execute if running on client or runtime (ie. don't call when on server)
		+	{ // BOOL pluginIsRunningOnFMPro set during plugin init
		+	// Check idle state
		+	switch (idleLevel)
		+	{
		+	case kFMXT_UserIdle:
		+	{
		+	// The user hasn't done anything for 30 seconds or more. (mouse movement don't reset this)
		+	}
		+	break;
		+
		+	case kFMXT_UserNotIdle:
		+	{
		+	// The user has done something within the last 30 seconds
		+	}
		+	break;
		+
		+	case kFMXT_ScriptPaused:
		+	{
		+	// The user is running a script that is paused
		+	}
		+	break;
		+
		+	case kFMXT_ScriptRunning:
		+	{
		+	// The user is running a script
		+	}
		+	break;
		+
		+	case kFMXT_Unsafe:
		+	{
		+	// The plug-in should wait and do nothing at this time.
		+	}
		+	break;
		+	}// switch idleLevel
		+
		+	}
		+	} // Do_PluginIdle