Generic Preexisting JavaScript Object

Overview

The Generic Preexisting JavaScript Object contains read only properties and methods which do not belong to a specific module. If you have configured 'PreloadLegacyGeneric' to be '1' the JavaScript object 'generic' will be inserted automatically into your page's DOM by RhoElements.

Syntax

Methods

Properties

Remarks

Play Flags

Flags are as follows:

0x00000000 = Play synchronously (default all but ET1).  The function returns after the sound event completes. (Not supported on ET1)
0x00000001 = The sound is played asynchronously (default on ET1 device).  To terminate an asynchronously played waveform 
             sound, call PlayWave with strSound set to null.
0x00000002 = No default sound event is used. If the sound cannot be found, PlayWave returns 
             silently without playing the default sound. (Not applicable on ET1)
0x00000008 = The sound plays repeatedly until PlayWave is called again with the strSound parameter 
             set to null. You must also specify the 0x00000001 flag to indicate an asynchronous 
             sound event.
0x00000010 = The specified sound event will yield to another sound event that is already playing. 
             If a sound cannot be played because the resource needed to generate that sound is 
             busy playing another sound, the function immediately returns without playing the 
             requested sound.  If this flag is not specified, PlaySound attempts to stop the 
             currently playing sound so that the device can be used to play the new sound.

Backwards Compatibility

The Generic Preexisting JavaScript Object provides backwards compatibility with code written for PocketBrowser and also supports the syntax below. Because RhoElements inserts the object 'generic' on the page automatically when 'PreloadLegacyGeneric' is configured to be '1' you can not create your own objects by this name, see below:

<script>
  //  Old PocketBrowser syntax supported by the Generic Object
  var gen = new ActiveXObject("PocketBrowser.Generic"); 

  //  Note: var generic = new ... will fail because the object already exists on the page.
  gen.Log('My Log Data', 1);
</script>

Requirements

HTML/JavaScript Examples

The Following example shows usage of the Generic object:

<script>
   //  Log some data as low severity
   generic.Log('Scanner data successfully received',1);
   //  Retrieve the type of terminal
   var myTerminal = generic.OEMInfo;
   //  Retrieve the UUID of the terminal
   var myUUID = generic.UUID;
   //  Play a wave file
   generic.PlayWave('\\windows\\alarm1.wav', 1);
</script>

The Following example shows usage of Invoke Meta Function:

<script>
   //  Enable the scanner
   generic.InvokeMETAFunction('Scanner', 'Enable');
   //  Configure the Scanner
   generic.InvokeMETAFunction('Scanner', 'all_decoders:disabled; ean8:enabled; Enabled');
   //  Show the signature capture window
   generic.InvokeMETAFunction('SignatureCapture', 'Visibility:Visible');
   //  Show and configure the battery icon
   generic.InvokeMETAFunction('Battery', 'Left:50; Top:50; IconPosition:Bottom; color:#FF0000; visibility:visible');
</script>

The Following example shows usage of the Generic object when controlling processes:

<script>
   //  Launch CtlPanel (blocking)
   var exitCode1 = generic.LaunchProcess('\\application\\ctlpanel.exe', '');

   //  Launch CtlPanel and see if the user closes it before 5 seconds
   var hProcess = generic.LaunchProcessNonBlocking('\\application\\ctlpanel.exe', '');
   var bRetVal = generic.WaitProcess(hProcess, 5);
   if (bRetVal)
   {
      var exitCode2 = generic.GetProcessExitCode(hProcess);
      alert('Process Ended by User: ' + exitCode2);
   }
   else
      alert('Process Still Running');
   generic.CloseProcess(hProcess);
</script>

The Following example shows usage of the Generic object for interfacing with the registry:

<script>
   //  Write a registry setting
   var REG_SZ = 1;
   var HKEY_LOCAL_MACHINE = 2;
   var szWrittenData = "Fred";
   generic.SetRegistrySetting(HKEY_LOCAL_MACHINE, REG_SZ, "Software\\Motorola\\MySettings", "Name", szWrittenData);

   //  Read back the previously written setting
   var szReadData = generic.GetRegistrySetting(HKEY_LOCAL_MACHINE, "Software\\Motorola\\MySettings",  "Name");
</script>

The Following example shows usage of the Generic object for reading / writing configuration settings:

<script>
   //  Read the FULLSCREEN setting and alert it to the user.
   var Ret = generic.ReadConfigSetting("FULLSCREEN");
   eval("var arrRet = "+Ret);
   if(arrRet.length){
    alert(arrRet[0]);
   }

   //  Show an alert with the scrollbar setting for an application named "Menu".
   var Ret = generic.ReadConfigSetting("SCROLLBARSENABLED","Menu");
   eval("var arrRet = "+Ret);
   if(arrRet.length){
    alert(arrRet[0]);
   }

   //  Show an alert for each preload in the application named "Menu".
   var loop;
   var Ret = generic.ReadConfigSetting("PRELOAD","Menu");
   eval("var arrRet = "+Ret);
   for(loop=0;loop < arrRet.length;loop++){
      alert(arrRet[loop]);
   }

   //  Set fullscreen off in the configuration file.
   var Ret = generic.WriteConfigSetting("FULLSCREEN","0");
   if(Ret=='true'){
    alert("Setting saved and will take place on the next RhoElements re-start");
   }

   //  Turn the scrollbars setting off for the application named "Menu".
   var Ret = generic.WriteConfigSetting("SCROLLBARSENABLED","0","Menu");
   if(Ret=='true'){
    alert("Setting saved and will take place on the next RhoElements re-start");
   }
</script>

The Following example shows usage of the Generic object for reading / writing user settings:

<script>
   //  Write the string 'red' to the custom setting 'bgcolor'
   var Ret = generic.WriteUserSetting("BgColor","red");
   if(Ret=='true'){
    alert("Custom setting saved");
   }

   //  Retrieve the value we have just written
   var Ret = generic.ReadUserSetting("BgColor");
   alert("background color is "+Ret);
</script>