REXXMigration (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.REXXMigration

All Implemented Interfaces:

NetPhantomConstants, ObjectCalling, ObjectMessages

Direct Known Subclasses:

ADMIN, AdminApplication, AdminApplicationConfig, ADMINCNF, AdminData, JavaREXXMigration, ONELOGIN_ONELOGIN, PHPSB_PHPSB, Template
```
public class REXXMigration
extends Object
implements ObjectCalling, ObjectMessages, NetPhantomConstants
```
The REXXMigration class is used as a base class to derive new Java classes that are ported from existing REXX programs, both REXX macros and REXX applications.
The purpose of this class is to make the NetPhantom API available to REXX programs as similar as possible for Java programs that are ported from REXX. Using this class as a base class will allow only a minimal change of the code, mostly to change the REXX syntax to Java.
Also see the NetRexxMigration class. A new instance of this object is created for each call to it. If a global instance is required, use the VirtualSessionManager methods saveObject(String name,Object object), Object getObject(String name) and removeObject(String name).
To gain access to the central object instances, use the PhantomWorker getWorker() as a starting point. The PhantomWorker instance holds what is required to handle the client session and the application data.
To get the instance of the control that issued the call, use VirtualInterface getVirtualInterface(), but be careful, it may return null. The VirtualInterface is the common interface for all Controls and Menu Items.
The return string to the called is set by a call to setReturnString(String s) before returning from the start(...) method.
Typical REXX program
Here is a listing of a typical REXX program (the comments have been removed). The name of the source file is B_DOWN.REX and so is the name of the Phantom Object defined in the application.
```
   Parse Arg argId, argMsg, argStr
   if argMsg = 'HCHG' then
   do
     if HostGetFld('', 'mehr_dwn') = '+' then
       rc = PanSetCtlStyle('B_DOWN', 1)
     else
       rc = PanSetCtlStyle('B_DOWN', 0)
   end
   if argMsg = 'CMD' then
   do
     if HostGetFld('', 'Mehrfach') <> 'M' then
     do
       rc = HostSetFld('', 'AUSWAHL', '__')
       rc = HostSetFld('', 'FUNKTION', '__')
       Anz_Zeilen = PanListGetNum('LIST')
       do i = 1 to Anz_Zeilen
         rc = HostSetFld('', 'SEL', '__', i)
       end
     end
     rc = HostSetFld('', 'COMMAND', '        ')
     rc = HostSend('@8',,, 1)
   end
   Return 0
 
```
Typical REXX program ported to Java
Here is a listing of how the source would look like after a port.
```
   import se.entra.phantom.server.REXXMigration;
   public class B_DOWN extends REXXMigration
     {
     public void start(String argId, int argMsg, String argStr)
       {
       int rc; // The return code.
       if ( argMsg == HCHG )
         {
         if ( HostGetFld("", "mehr_dwn").equals("+") )
           rc = PanSetCtlStyle("B_DOWN", 1);
         else
           rc = PanSetCtlStyle("B_DOWN", 0);
         }
       if ( argMsg == CMD )
         {
         if ( !HostGetFld("", "Mehrfach").equals("M") )
           {
           rc = HostSetFld("", "AUSWAHL", "__");
           rc = HostSetFld("", "FUNKTION", "__");
           int Anz_Zeilen = PanListGetNum("LIST");
           for ( int i = 1; i <= Anz_Zeilen; i++ )
             rc = HostSetFld("", "SEL", "__", i);
           rc = HostSetFld("", "COMMAND", "        ");
           rc = HostSend("@8", 0, 0, 1);
           }
         }
       }
     }
 
```
External REXX functions
External REXX functions called directly from REXX like:
```
   rc=my_external_function('param1',10)
 
```
should be done in Java like:
```
   my_external_function m_e_f = new my_external_function(); // Only needed once.
   m_e_f.setWorker(getWorker());                            // Only needed once.
   int rc = m_e_f.aNewFunction("param1", 10);
 
```
and the "my_external_function" class:
```
   import se.entra.phantom.server.REXXMigration;
   public class my_external_function extends REXXMigration
     {
     public int aNewFunction(String p1, int i2)
       {
       // ...code...
       return 0;
       }
     }
 
```
Unsupported REXX functions
The following list of functions are not supported:
```
 | Name             Comment
 | ---------------  ------------------------------------------------------
 |
 | HostSetScreen    Used by PhantomProcessor in Phantom Hurricane 2.5
 | HostSendPassword
 |
 | HostLockSession  No terminal screen is used
 | HostDisable
 |
 | GetInput         Used for Phantom Processor
 |
 | RxVarSave        REXX variables are too tied to the REXX language
 | RxVarRestore
 | RxVarDelete
 |
 
```
Control IDs
Control IDs are used to reference controls of any kind. An ID is only necessary when a reference is needed. The maximum length is eight characters but to support addressing of controls in different notebook pages or different panels, the panel ID plus control ID can be combined with a slash (/). For example, get the text in the entry field "ENTRY1" on the notebook page "PAGE3":
```
   String txt = PanGetCtlData("PAGE3/ENTRY1");
 
```
This combined control reference can only be made from a program object, never from another control.
There are three special control IDs that are used to reference different parts of the application: *APP, *PANEL and *MENUITEM. The first two can be used to set and get the title bar text of the application area or a panel. *MENUITEM (where MENUITEM is replaced by a menu ID) references a menu item in the application menu. The IDs *MENUITEM and *APP can not be combined with a panel ID as there can only be one application area.
Example: Get the title bar text of the panel "PAN1".
```
   String txt = PanGetCtlData("PAN1/*PANEL");
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CTLSTYLE_DISABLE` Value to disable a control.
`static int`	`CTLSTYLE_ENABLE` Value to enable a control.
`static int`	`CTLSTYLE_HIDE` Value to hide a control.
`static int`	`CTLSTYLE_READONLY` Value to set entryfield as READONLY when disabled.
`static int`	`CTLSTYLE_SHOW` Value to show a control.
`static int`	`MAX_TIMEOUT` Max timeout value.
`static int`	`REXX_ERR_FILENOTFOUND` File not found error.
`static int`	`REXX_ERR_GENERAL` General error.
`static int`	`REXX_ERR_HOSTFLDNOTFOUND` Host field not found error.
`static int`	`REXX_ERR_NOSTATE` Wrong or no state error.
`static int`	`REXX_ERR_NOTFOUND` Object not found error.
`static int`	`REXX_ERR_READERROR` File read error.
`static int`	`REXX_ERR_TIMEOUT` Timeout error.

Fields inherited from interface se.entra.phantom.server.ObjectCalling
CHAR, CHECK, CLK, CLOSE, CMD, CRT, DBLCLK, DEFOC, FOC, HCHG, HIDDEN, QMSG, RECRT, REM, SEL, SHOW, START, UCHG, XLATE

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants
ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Constructor Summary

Constructors
Constructor and Description

REXXMigration()
No need for a constructor in the derived class.

Constructors
Constructor and Description
`REXXMigration()` No need for a constructor in the derived class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`CallObject(String objectID, String controlID, int action, String string)` Calls a NetPhantom object.
`protected String`	`CharIn(String stream, long position, int length)` CharIn returns a string of up to length characters read from the character input stream name.
`protected long`	`CharOut(String streamname, String data, long position)` CharOut returns the count of characters remaining after attempting to write string to the character output stream name.
`protected long`	`Chars(String streamname)` Chars returns the total number of characters remaining in the character input stream name.
`protected String`	`ClientExecute(boolean async, String command, String data)` Performs a task on the client side.
`protected String`	`ClipbrdGet()` This method get the clipboard data from the client.
`protected int`	`ClipbrdSet(String data)` This method set the clipboard on the client.
`protected int`	`CompLine(int line, String string)` This method compares a text string containing wildcards with a line on the host screen.
`protected int`	`CompPos(int line, int column, String string)` This method compares a text string without wildcards with a certain position (line and column) on the host screen.
`protected int`	`CompScreen(String string)` This method compares a text string containing wildcards with the entire host screen.
`protected String`	`CreateTempFile()` Creates a temporary file in the directory of the current runtime file and adds it for removal when the client session is disposed of.
`protected String`	`Date(String form)` Return a formatted current date.
`protected int`	`DdeExecute(int dde_nn, String command)` This function sends the DDE verb EXECUTE to the application and the subject that is initiated to dde_nn.
`protected int`	`DdeInitiate(String programName, String subject)` This function requests communication with the program ProgramName with the subject Subject.
`protected int`	`DdePoke(int dde_nn, String location, String data)` This function sends the DDE verb POKE to the application and subject which is initiated to dde_nn.
`protected int`	`DdeTerminate(int dde_nn)` This function exits communication with the DDE session dde_nn.
`protected int`	`DeleteFile(String fileName)` Deletes a file.
`protected String`	`ExecuteProcess(String dir, boolean useRuntimeDir, String cmdLine)` Executes a Process, waiting for the response code and reading the STDOUT/STDERR output streams.
`protected int`	`FileAppend(String fileName, String data)` Adds the line data to the end of the file with the name fileName.
`protected int`	`FileCreate(String fileName)` Creates an empty file with the name fileName.
`protected String`	`FileSpec(String opt, String path)` FileSpec returns a selected element of filespec, a given file specification, identified by one of the following strings for option:
`CodepageConverter`	`getCodepageConverter()` Gets the CodepageConverter that is appropriate for writing files with this runtime.
`protected PhantomHostField`	`getHostFieldFromID(String screenName, String fieldName)` Internal method to get host field from current host screen or specified host screen or return null if not exist.
`protected PhantomHostScreen`	`getHostScreenFromID(String screenName)` Internal method to get NetPhantom host screen from current host screen or specified host screen name or return null if not exist.
`String`	`getReturnString()` Gets the return string for the object.
`protected VirtualInterface`	`getVirtualComponentFromID(String compID)` Get control, menu item or special information.
`VirtualInterface`	`getVirtualInterface()` Method to get the virtual interface to the calling object.
`PhantomWorker`	`getWorker()` Method to get the interface to the PhantomWorker class.
`protected int`	`GlobVarDelete(String varName)` Deletes a NetPhantom global variable.
`protected String`	`GlobVarGet(String varName)` Gets a global variable.
`protected int`	`GlobVarSet(String varName, String data)` Sets a NetPhantom global variable.
`protected int`	`HostConnect(String sessionID)` Starts communication with a host session.
`protected int`	`HostDisconnect()` Disconnects communication with current host session.
`protected int`	`HostError()` Checks for errors in in contact with the host session.
`protected int`	`HostGetCol()` Returns the current column location of the cursor in the session (1-80 or the maximum size of the screen at the time).
`protected String`	`HostGetCurrFld()` Gets the current host field of the current screen (to get the current screen use HostGetScreen).
`protected String`	`HostGetFld(String screenName, String fieldName, int lineNo)` Retrieves the contents of a host field.
`protected String`	`HostGetFldAttr(String screenName, String fieldName, int lineNo)` Retrieves the attribute of a host field.
`protected int`	`HostGetFldClr(String screenName, String fieldName, int lineNo)` Retrieves the color of a host field.
`protected int`	`HostGetFldLen(String screenName, String fieldName, int lineNo)` Returns the length of the host field FieldName or 0 if not found.
`protected String`	`HostGetLastErr(int clear)` Retrieves the last host error message for 5250.
`protected String`	`HostGetLine(int lineNo)` Returns a line from the host screen.
`protected int`	`HostGetRow()` Returns the current row of the cursor in the session.
`protected String`	`HostGetScreen()` Returns the current matching screen or empty string if none.
`protected String`	`HostGetSession()` Returns the current host session's ID (A-Z)
`protected String`	`HostGetString(int line, int column, int length)` Returns a string from the host screen.
`protected int`	`HostGetTimeout()` Returns the current time-out value in seconds (0-998 seconds, 999=no time-out).
`protected int`	`HostHideSession(int hide)` This method hides or shows the terminal emulator window.
`protected int`	`HostSend(String string, int startTimer, int stopTimer, int newMsg)` Sends a series of keystrokes to the host and waits for the lock state to disapear.
`protected int`	`HostSendDirect(String string, int newMsg)` Sends a series of keystrokes to the host.
`protected int`	`HostSendFilePsw(String userID)` Sends a password to the host which is then stored on disk in encrypted form.
`protected int`	`HostSetCursor(int line, int column)` Sets the cursor position.
`protected int`	`HostSetCursorToFld(String fieldName, int lineOffset)` Sets the cursor position to the beginning of a host field with a line offset.
`protected int`	`HostSetFld(String screenName, String fieldName, String data, int lineNo)` Sets a host field with text.
`protected int`	`HostSetTimeout(int timeoutValue)` Sets the time-out value used in waiting and comparison functions.
`protected int`	`HostWait(int numWait)` Waits for the "wait" state of the session to disappear.
`protected int`	`HostWaitScreen()` Waits for any screen change, e.g.
`protected String`	`LineIn(String streamname, long pos, long count)` LineIn returns count (0 or 1) lines read from the character input stream name.
`protected int`	`LineOut(String streamname, String data, long line)` LineOut returns the count of lines remaining after attempting to write string to the character output stream name.
`protected int`	`Lines(String streamname)` Lines returns 1 if any data remains between the current read position and the end of the character input stream name, and returns 0 if no data remains.
`protected boolean`	`LogMsg(String msg)` Send log entry to direct logger.
`protected int`	`LogonGet()` Reads the logon state of the currently initiated session.
`protected int`	`LogonSet(int logonFlag)` Sets the logon state of the currently initiated session.
`protected String`	`MacroPlay(String macroName, String[] arguments)` This function plays back a macro.
`protected int`	`Message(int type, int icon, String message)` Requests and displays a message to the user.
`protected int`	`PanCallCtl(String controlID)` Activates a menu item or a push button with control ID `controlID`.
`protected String`	`PanChart(String controlID, String function, String data)` Function for processing graphical charts.
`protected int`	`PanCheckGet(String controlID)` Retrieves the selection of a radio button or check box.
`protected int`	`PanCheckSet(String controlID, int checkState)` Sets the selection of a radio button or check box.
`protected int`	`PanComboFromFile(String controlID, String fileName)` Fills a combination box with contents of a text file.
`protected int`	`PanCreate(String panelID)` Creates a new panel.
`protected int`	`PanDestroy()` Removes or destroys the topmost panel.
`protected int`	`PanelExit()` Exits the current client session.
`protected boolean`	`PanEnableClientProcessing(boolean on)` Enabled or disables all client processing.
`protected int`	`PanEnd(String string)` Exits a PanProcess function issued from another thread with string.
`protected String`	`PanFormatText(String text)` Parses string to resolve @-sequences.
`protected String`	`PanGetCtlData(String controlID)` Retrieves the contents of a panel control.
`protected int`	`PanGetCtlLen(String controlID)` Get the length of a panel control.
`protected String`	`PanGetCtlProperty(String controlID, String property)` Retrieves a property of a panel control.
`protected int`	`PanGetCtlStyle(String controlID)` Retrieves a control style.
`protected String`	`PanGetCurrNbPage(String controlID)` Get the current notebook page.
`protected String`	`PanGetCurrPanel()` Retrieves the name of the current panel.
`protected String`	`PanGetDllExt(String name)` Get a system dependent extension of a file name.
`protected String`	`PanGetFocus()` Get the current panel/control that has focus or empty string if focus not could be found.
`protected String`	`PanGetText(String textID)` Retrieves a text from the current text file.
`protected int`	`PanHostInhibit(int inhibitState)` Removes or restores panel processing between NetPhantom and the terminal session.
`protected boolean`	`PanIsClientProcessingEnabled()` Checks if client processing is enabled.
`protected int`	`PanListClear(String controlID)` Clears a list of all its contents.
`protected int`	`PanListDelete(String controlID, int line)` Deletes a line (1-nn) from a list.
`protected int`	`PanListFromFile(String controlID, String fileName)` Fills a list with data from a text file.
`protected String`	`PanListGetData(String controlID, int lineNo)` Retrieves the contents of a line (1-nn) in a list.
`protected String`	`PanListGetFld(String controlID, int lineNo, int columnNo)` Function to retrieve a list field (a line [1-nn] and a column [1-columnCount]).
`protected int`	`PanListGetNum(String controlID)` Get number of lines in a list.
`protected int`	`PanListGetSel(String controlID, int prevLine)` Retrieves the next selected line in a list or zero if no more selections exists.
`protected int`	`PanListInsertData(String controlID, int line, String data)` Adds or inserts a line of Data in a list.
`protected int`	`PanListSetData(String controlID, int lineNo, String data)` Update a line in a list.
`protected int`	`PanListSetFld(String controlID, int lineNo, int columnNo, String data)` Function to set a list field (a line [1-nn] and a column [1-columnCount]).
`protected int`	`PanListSetSel(String controlID, int line, int selectionState)` Selects or deselects a line in a list.
`protected int`	`PanListToFile(String controlID, String fileName)` Stores the contents of a list into a text file.
`protected int`	`PanLock(int lockState)` Locks or restores user panel processing.
`protected int`	`PanNbCancelPaging()` Cancels notebook paging when a user has selected a notebook page that is not the Next or the Previous one.
`protected int`	`PanPreload(String panelID)` Preloads a panel the same way as when next panel is connected to a push button or a menu item.
`protected String`	`PanProcess()` Starts processing a panel.
`protected int`	`PanRemove()` Removes or destroys the topmost panel.
`protected int`	`PanSelectCurrCtl()` This function selects the current entry field.
`protected int`	`PanSetCtlClr(String controlID, int foreground, int background)` This function set or removes the colors of a control.
`protected int`	`PanSetCtlData(String controlID, String data)` Sets the contents of a panel control.
`protected int`	`PanSetCtlLen(String controlID, int length)` Set the length of a panel control.
`protected int`	`PanSetCtlProperty(String controlID, String property, String data)` Sets a property of a panel control.
`protected int`	`PanSetCtlStyle(String controlID, int style)` Sets style of panel control.
`protected int`	`PanSetCurFromHost()` Places the cursor in the panel in the same position it has in the terminal session.
`protected int`	`PanSetFocus(String controlID, int selectControl)` Sets focus to a panel control.
`protected int`	`PanSetPanelFromHost(String[] panels)` Sets the correct panel from the current cursor position.
`protected boolean`	`PanSetRatioAndFontScaling(int ratioX, int ratioY, boolean doScaleFonts)` Sets the ratioX and ratioY parameters and if the fonts should be scaled with these ratio parameters also.
`protected int`	`PanSetTextFile(String fileName)` Swaps the current text file for the specified file name.
`protected int`	`PanSetXlateFile(String fileName)` Swaps the current translation file for the specified file name.
`protected int`	`PanUpdate()` Updates all controls and menus in the panel in respect to text and translation files and the current host screen.
`protected String`	`PanXlate(String text)` Translates the string using the current translation table.
`protected int`	`RemoveTempFile(String fileName)` Removes a temporary file name from the client session.
`protected String`	`Report(String com, String p1, String p2, String p3, String p4, String p5)` Handles the printing of a report.
`protected boolean`	`RotateLog()` Rotate the log file (if configured to rotate on log file size).
`protected int`	`ScrComp(String screenName)` Compares the host screen with screen name without waiting.
`protected String`	`ScrGetNext()` Retrieves the name of the next matching screen identity after ScrMatch.
`protected int`	`ScrMatch()` Matches the screen with all the screen identities.
`protected int`	`ScrMultiWait(String[] screenNames)` Waits until the screen matches one of the specified screen identities.
`protected String`	`ScrMultiWait2(String[] screenNames)` Waits until the screen matches one of the specified screen identities.
`protected int`	`ScrWait(String screenName)` Waits until the screen matches the screen identity.
`protected String`	`SendEmail(String com, String p1)` Handles the mail functionality.
`protected String`	`SendSMS(String command, String param1, String param2)` Handles the sms functionality.
`protected int`	`SessionExit()` Exits the current client session.
`protected String`	`SessionGet()` Retrieves the session that is in the foreground.
`protected String`	`SessionGetAll()` Retrieves all the sessions that have been started.
`protected int`	`SessionSelect(String sessionID)` Places the session in the foreground of all panel sessions.
`protected int`	`SessionStart(String sessionID)` Starts a new main panel session for an application panel.
`protected int`	`SessionStop(String sessionID)` Stops a panel session.
`protected int`	`SessVarDelete(String varName)` Deletes a session variable.
`protected String`	`SessVarGet(String varName)` Gets a session variable.
`protected int`	`SessVarSet(String varName, String data)` Sets a session variable.
`void`	`setReturnString(String s)` Sets the return string for the object.
`void`	`setVirtualInterface(VirtualInterface vI)` Method to set the virtual interface to the calling object.
`void`	`setWorker(PhantomWorker p)` Method to setup the interface to the PhantomWorker class.
`protected int`	`ShowDocument(String url, String target)` Show HTML document from applet.
`void`	`start(String argId, int argMsg, String argStr)` This is the function that starts the Java object.
`protected boolean`	`StartLog()` Set direct logging active.
`protected boolean`	`StopLog()` Set direct logging inactive.
`protected String`	`Stream(String streamname, String operation, String command)` Stream returns a string describing the state of, or the result of an operation upon, the character stream name.
`protected String`	`Time(String form)` Return a formatted current time.
`protected String`	`TimerGet(int timerNo)` Returns the current reading on a timer (1-9) in hundredth of seconds.
`protected int`	`TimerPause(int timerNo)` Pauses a timer (1-9).
`protected int`	`TimerStart(int timerNo)` Starts a timer (1-9).
`protected int`	`TimerStop(int timerNo)` Stops a timer (1-9).
`protected int`	`Wait(int seconds)` Waits for the number of seconds specified.
`protected int`	`WCompLine(int line, String string, int timer)` This method compares a text string containing wildcards with a line on the host screen.
`protected int`	`WCompPos(int line, int column, String string, int timer)` This method compares a text string without wildcards with a certain position (line and column) on the host screen.
`protected int`	`WCompScreen(String string, int timer)` This method compares a text string containing wildcards with the entire host screen.
`protected int`	`XDdeAdvise(int hConv, String item, int flags)` This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv send the data connected to Item every time it changes.
`protected int`	`XDdeExecute(int hConv, String command)` This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv execute the Command.
`protected int`	`XDdeInitiate(String progName, String topicName, String objectName)` This functions initiates the requested DDE conversation.
`protected int`	`XDdePoke(int hConv, String item, String data)` This functions submits a request to the DDE Engine to poke the unsolicited Data to the Item in the conversation identified by hConv.
`protected int`	`XDdeRequest(int hConv, String item)` This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv send the data connected to Item.
`protected int`	`XDdeTerminate(int hConv)` This functions submits a request to the DDE Engine to terminate the DDE conversation identified by hConv.
`protected int`	`XDdeUnadvise(int hConv, int hReq)` This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv terminate the advise link identified by hReq.
`protected int`	`XDdeUpdate(String topic, String item, String data)` This functions notifies the DDE Engine that the data for Topic, item has changed to Data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_TIMEOUT
```
public static final int MAX_TIMEOUT
```
    Max timeout value.
    
    See Also:
    
    Constant Field Values
  - CTLSTYLE_DISABLE
```
public static final int CTLSTYLE_DISABLE
```
    Value to disable a control.
    
    See Also:
    
    Constant Field Values
  - CTLSTYLE_ENABLE
```
public static final int CTLSTYLE_ENABLE
```
    Value to enable a control.
    
    See Also:
    
    Constant Field Values
  - CTLSTYLE_HIDE
```
public static final int CTLSTYLE_HIDE
```
    Value to hide a control.
    
    See Also:
    
    Constant Field Values
  - CTLSTYLE_SHOW
```
public static final int CTLSTYLE_SHOW
```
    Value to show a control.
    
    See Also:
    
    Constant Field Values
  - CTLSTYLE_READONLY
```
public static final int CTLSTYLE_READONLY
```
    Value to set entryfield as READONLY when disabled.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_GENERAL
```
public static final int REXX_ERR_GENERAL
```
    General error.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_TIMEOUT
```
public static final int REXX_ERR_TIMEOUT
```
    Timeout error.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_NOSTATE
```
public static final int REXX_ERR_NOSTATE
```
    Wrong or no state error.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_FILENOTFOUND
```
public static final int REXX_ERR_FILENOTFOUND
```
    File not found error.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_READERROR
```
public static final int REXX_ERR_READERROR
```
    File read error.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_HOSTFLDNOTFOUND
```
public static final int REXX_ERR_HOSTFLDNOTFOUND
```
    Host field not found error.
    
    See Also:
    
    Constant Field Values
  - REXX_ERR_NOTFOUND
```
public static final int REXX_ERR_NOTFOUND
```
    Object not found error.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - REXXMigration
```
public REXXMigration()
```
    No need for a constructor in the derived class.
- Method Detail
  - setWorker
```
public void setWorker(PhantomWorker p)
```
    Method to setup the interface to the PhantomWorker class.
    
    Specified by:
    
    setWorker in interface ObjectCalling
  - getWorker
```
public PhantomWorker getWorker()
```
    Method to get the interface to the PhantomWorker class.
    
    Specified by:
    
    getWorker in interface ObjectCalling
  - setVirtualInterface
```
public void setVirtualInterface(VirtualInterface vI)
```
    Method to set the virtual interface to the calling object.
    
    Specified by:
    
    setVirtualInterface in interface ObjectCalling
  - getVirtualInterface
```
public VirtualInterface getVirtualInterface()
```
    Method to get the virtual interface to the calling object.
    
    Specified by:
    
    getVirtualInterface in interface ObjectCalling
  - setReturnString
```
public void setReturnString(String s)
```
    Sets the return string for the object.
    
    Specified by:
    
    setReturnString in interface ObjectCalling
  - getReturnString
```
public String getReturnString()
```
    Gets the return string for the object.
    
    Specified by:
    
    getReturnString in interface ObjectCalling
  - start
```
public void start(String argId,
                  int argMsg,
                  String argStr)
```
    This is the function that starts the Java object. It is called from NetPhantom with the appropriate arguments.
    Every derived Java class should override this method.
    Valid messages are CRT, REM, UCHG, HCHG, FOC, DEFOC, CLK, DBLCLK, CMD, SEL, CLOSE, CHAR, CHECK, HIDDEN, RECRT, XLATE, START, SHOW, QMSG, DDEPOKE, DDEEXEC, DDEREQ, DDEVAL, DDECONN, DDEERR and DDEDATA).
    
    Specified by:
    
    start in interface ObjectCalling
  - HostConnect
```
protected int HostConnect(String sessionID)
                   throws IllegalArgumentException
```
    Starts communication with a host session.
    The ID of the host session is a letter from A to Z or "." to diconnect from all sessions. This is the letter that is specified in the configuration in terminal emulation software. Check this ID in terminal profiles/sessions in server.ini file.
    If that session is already connected, the call to the function will be ignored. Otherwise contact with any session is canceled to change to the session requested.
    Returns:
```
   0 = No error.
   1 = Unable to establish contact with the host session.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostDisconnect(), HostGetSession()
  - HostDisconnect
```
protected int HostDisconnect()
```
    Disconnects communication with current host session. If there is no communication with a host session, the call to this function is ignored.
    Returns: Always zero.
    
    See Also:
    
    HostConnect(java.lang.String), HostGetSession()
  - HostGetSession
```
protected String HostGetSession()
```
    Returns the current host session's ID (A-Z)
    Returns:
```
   'A' to 'Z' if connected to host session.
   space ' ' or period '.' if disconnected from all host sessions.
 
```
    See Also:
    
    HostConnect(java.lang.String), HostDisconnect()
  - HostError
```
protected int HostError()
```
    Checks for errors in in contact with the host session.
    Returns:
```
   0 = No error.
   1 = Communication error with host.
 
```
  - HostSetTimeout
```
protected int HostSetTimeout(int timeoutValue)
                      throws IllegalArgumentException
```
    Sets the time-out value used in waiting and comparison functions. The value specifies the number of seconds to wait (0-998). If 999 seconds is specified it is assumed that there will be no time-out (not recommended!).
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetTimeout(), HostWait(int), HostSend(java.lang.String, int, int, int), MacroPlay(java.lang.String, java.lang.String[]), ScrWait(java.lang.String)
  - HostGetTimeout
```
protected int HostGetTimeout()
```
    Returns the current time-out value in seconds (0-998 seconds, 999=no time-out).
    
    See Also:
    
    HostSetTimeout(int), HostWait(int), HostSend(java.lang.String, int, int, int), MacroPlay(java.lang.String, java.lang.String[]), ScrWait(java.lang.String)
  - HostGetRow
```
protected int HostGetRow()
```
    Returns the current row of the cursor in the session. The function will return zero if unable to retrieve position.
    
    See Also:
    
    HostGetCol()
  - HostGetCol
```
protected int HostGetCol()
```
    Returns the current column location of the cursor in the session (1-80 or the maximum size of the screen at the time).
    Return Value:
```
   0     Unable to retrieve position.
   1-nn  Row number.
 
```
    See Also:
    
    HostGetRow(), HostSetCursor(int, int)
  - HostSetCursor
```
protected int HostSetCursor(int line,
                            int column)
                     throws IllegalArgumentException
```
    Sets the cursor position.
    Parameters:
```
   line    Cursor line (1-nn).
   column  Cursor column (1-nn).
 
```
    Return Value:
```
   0  No error.
   1  Unable to set cursor position.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetCol(), HostGetRow()
  - HostWait
```
protected int HostWait(int numWait)
                throws IllegalArgumentException
```
    Waits for the "wait" state of the session to disappear. The parameter numWait specifies the number of times to wait. If numWait is less than 1, 1 (one) is assumed. The reason for having numWait is that a host session may "flip" the lock state a number of times before the session is unlocked fully. This is quite common with 3270 sessions.
    This function cannot be used with Java macros.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostWaitScreen()
  - HostWaitScreen
```
protected int HostWaitScreen()
```
    Waits for any screen change, e.g. a change in cursor position or character. This function cannot be used with Java macros. Be careful using this function; be sure you want to wait for any screen change. If you are unsure, use HostWait.
    
    See Also:
    
    HostWait(int)
  - HostSend
```
protected int HostSend(String string,
                       int startTimer,
                       int stopTimer,
                       int newMsg)
                throws IllegalArgumentException
```
    Sends a series of keystrokes to the host and waits for the lock state to disapear. The key codes (see below) are listed in Appendix J.
    Parameters:
```
   string       String of characters and Key codes that will be send to the
                host.
   start_timer  Timer (1-9, 0 = no timer) that will be started when calling
                this function.
   stop_timer   Timer (1-9, 0 = no timer) that will be stopped when the
                wait state disappears from the host.
   newMsg       The flag NewMsg is set if the application is to set the
                cursor position from host in the graphical panel and
                message boxes of the type "New message after send key" are
                to be checked.
 
```
    Returns:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostSendDirect(java.lang.String, int), HostWait(int)
  - HostSendDirect
```
protected int HostSendDirect(String string,
                             int newMsg)
                      throws IllegalArgumentException
```
    Sends a series of keystrokes to the host. The key codes (see below) are listed in Appendix J. In contrast to HostSend, this function does not wait for the session's wait state to disappear. Keystrokes may include special or sending keys (e.g. Enter, F3, etc.).
    Parameters:
```
   string  String of characters and Key codes that will be send to the host.
   newMsg  The flag NewMsg is set if the application is to set the cursor
           position from host in the graphical panel and message boxes of
           the type "New message after send key" are to be checked.
 
```
    Returns:
```
   0  No error.
   1  Communication error with host.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostSend(java.lang.String, int, int, int)
  - HostSendFilePsw
```
protected int HostSendFilePsw(String userID)
                       throws IllegalArgumentException
```
    Sends a password to the host which is then stored on disk in encrypted form. The password is encrypted with the aid of the NetPhantom Editor.
    Parameter
```
   userID  User ID file name created by NetPhantom Editor containing password.
 
```
    Returns:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostSend(java.lang.String, int, int, int), HostWait(int)
  - HostGetLine
```
protected String HostGetLine(int lineNo)
                      throws IllegalArgumentException
```
    Returns a line from the host screen. If the line number (1-nn) is wrong an empty string will be returned.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetFld(java.lang.String, java.lang.String, int)
  - HostGetString
```
protected String HostGetString(int line,
                               int column,
                               int length)
                        throws IllegalArgumentException
```
    Returns a string from the host screen. If the parameters are wrong an empty string will be returned
    Parameters:
```
   line    Line in host (1-nn).
   column  Column in host (1-nn).
   length  Length of string.
 
```
    Comments:
    Note that the string must all be located on one line (i.e. no wrap).
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetFld(java.lang.String, java.lang.String, int), HostGetLine(int)
  - HostSetFld
```
protected int HostSetFld(String screenName,
                         String fieldName,
                         String data,
                         int lineNo)
                  throws IllegalArgumentException
```
    Sets a host field with text.
    Parameters:
```
   screenName  Name of host screen (can be empty or null for current
               screen).
   fieldName   Name of host field.
   data        String to set field with.
   lineNo      Line number in host field (for multiple line host fields,
               zero otherwise).
 
```
    Returns:
```
   0  No error.
   1  General error.
   9  Field not found.
 
```
    Comments:
    Fills the field fieldName for the screen identity screenName with the data. A line number can be specified if the field is a list box (connected to a panel field of the list type), in which case enter the line number (1=first line, etc.). If the screen name is empty or null the current matching screen is assumed.
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetFld(java.lang.String, java.lang.String, int)
  - HostGetFld
```
protected String HostGetFld(String screenName,
                            String fieldName,
                            int lineNo)
                     throws IllegalArgumentException
```
    Retrieves the contents of a host field. Looks in the first position. A line number can be specified if the consists of more than one row, in which case enter the line number (1=first line, etc.). If the screen name is empty or null, the current matching screen is assumed.
    Parameters:
```
   screenName   Name of host screen (empty or null is current screen).
   fieldName    Name of host field.
   lineNo       Used when a host field consists of more than one row.
 
```
    Returns field contents or empty string if the field data could not be retrieved.
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostSetFld(java.lang.String, java.lang.String, java.lang.String, int)
  - HostGetFldClr
```
protected int HostGetFldClr(String screenName,
                            String fieldName,
                            int lineNo)
                     throws IllegalArgumentException
```
    Retrieves the color of a host field.
    Parameters:
```
   screenName   Name of host screen (if name is empty or null, the current
                screen is assumed).
   fieldName    Name of host field.
   lineNo       Used when a host field consists of more than one row.
 
```
    Comments:
    Retrieves the color of the field fieldName for the screen identity screenName. A line number can be specified if the field is a list box (connected to a panel control of the list type), in which case enter the line number (1=first line, etc.). If the screen name is empty, the current matching screen is assumed.
    The color of the field is from 0 to 255. Both foreground and background colors are retrieved. For a list of colors see Appendix H Host Field Colors.
    Throws:
    
    IllegalArgumentException
  - HostGetScreen
```
protected String HostGetScreen()
```
    Returns the current matching screen or empty string if none.
  - HostGetLastErr
```
protected String HostGetLastErr(int clear)
                         throws IllegalArgumentException
```
    Retrieves the last host error message for 5250.
    Setting the clear flag will clear the error message.
    Returns last error message as a string or empty string if no error message exists.
    
    Throws:
    
    IllegalArgumentException
  - HostGetFldAttr
```
protected String HostGetFldAttr(String screenName,
                                String fieldName,
                                int lineNo)
                         throws IllegalArgumentException
```
    Retrieves the attribute of a host field. Retrieves the attribute of the field fieldName for the screen identity screenName. A line number can be specified if the field is a list box (connected to a panel control of the list type), in which case enter the line number (1=first line, etc.). If the screen name is empty or null the current matching screen is assumed.
    Parameters:
```
   screenName   Name of host screen (empty is current screen).
   fieldName    Name of host field.
   lineNo       Used when a host field consists of more than one row.
 
```
    The attribute of a field is Protected, Hidden or both.
    Return values:
    Returns field attribute as a two character string. First character "P" = protected or " " (space) = not protected. Second character "H" = Hidden or " " (space) = not hidden.
```
   1  Unable to retrieve field attribute.
   9  Field not found.
 
```
    Throws:
    
    IllegalArgumentException
  - HostGetFldLen
```
protected int HostGetFldLen(String screenName,
                            String fieldName,
                            int lineNo)
                     throws IllegalArgumentException
```
    Returns the length of the host field FieldName or 0 if not found. It measures the length of the actual host field, not just the area that has been identified as a field. As in other Host functions, screenName can be empty or null if the current screen should be used.
    Parameters:
```
   screenName   Name of any host screen. Empty is current screen.
   fieldName    Name of host field.
   lineNo       An optional line number for multiple line fields.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetFld(java.lang.String, java.lang.String, int)
  - HostGetCurrFld
```
protected String HostGetCurrFld()
```
    Gets the current host field of the current screen (to get the current screen use HostGetScreen). It will also return the line number where the cursor is located if the host field has multiple lines (or is continued).
    It will return a string consisting of the current field name and line number, or it will return an empty string.
    
    See Also:
    
    HostSetCursorToFld(java.lang.String, int), HostGetScreen()
  - HostSetCursorToFld
```
protected int HostSetCursorToFld(String fieldName,
                                 int lineOffset)
                          throws IllegalArgumentException
```
    Sets the cursor position to the beginning of a host field with a line offset.
    Parameters:
```
   fieldName    Name of host field.
   lineOffset   The line number to which the cursor should be set (1-nn).
 
```
    Returns:
```
   0  No error.
   1  General error.
   9  Field not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    HostGetCurrFld(), HostSetCursor(int, int)
  - HostHideSession
```
protected int HostHideSession(int hide)
                       throws IllegalArgumentException
```
    This method hides or shows the terminal emulator window.
    Parameters:
```
   hide   Set to 0 (zero) if the terminal window should be displayed or 1 if it should be hidden.
 
```
    Returns:
```
   0  No error.
   1  Unable to hide/show window.
 
```
    Throws:
    
    IllegalArgumentException
  - MacroPlay
```
protected String MacroPlay(String macroName,
                           String[] arguments)
```
    This function plays back a macro.
    If the macro has a number of parameters these should be specified. The number may vary from none to a maximum of ten. The macro works with the current time-out setting for waiting for screens. Naturally, this can be reset from the macro.
    If time-out is reached (return Value 2), find the screen in which the macro is located and continue working from this screen.
    The maximum length of each parameter is 80 characters.
    This function should only be used from Java applications if screens switches exist in the macro. If the macro only fills the current screen with information, a Java macro may be used. Recommendation: use REXX application.
    Return values:
```
   0      No error.
   1      Unable to retrieve field attribute.
   2      Time-out.
   9      Macro not found.
   other  Any Java programs called up from within the macro may return
          other values or strings.
 
```
  - ScrComp
```
protected int ScrComp(String screenName)
               throws IllegalArgumentException
```
    Compares the host screen with screen name without waiting.
    Return values:
```
   0  Screen matches.
   1  General error.
   2  Time-out.
   4  No match.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    ScrWait(java.lang.String), ScrMultiWait(java.lang.String[])
  - ScrWait
```
protected int ScrWait(String screenName)
               throws IllegalArgumentException
```
    Waits until the screen matches the screen identity.
    The maximum waiting period is the current time-out.
    Return values:
```
   0  Screen found.
   1  General error.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    ScrComp(java.lang.String), ScrMultiWait(java.lang.String[])
  - ScrMultiWait
```
protected int ScrMultiWait(String[] screenNames)
                    throws IllegalArgumentException
```
    Waits until the screen matches one of the specified screen identities.
    The maximum waiting period is the current time-out. At least one screen name must be specified.
    Return values:
```
   0  One of the screens found.
   1  General error.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    ScrMatch(), ScrWait(java.lang.String), ScrComp(java.lang.String), HostWait(int)
  - ScrMultiWait2
```
protected String ScrMultiWait2(String[] screenNames)
```
    Waits until the screen matches one of the specified screen identities.
    The maximum waiting period is the current time-out. At least one screen name must be specified.
    Return values:
```
   ScreenName    One of the screens found.
       1         General error.
       2         Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    ScrMatch(), ScrWait(java.lang.String), ScrComp(java.lang.String), HostWait(int)
  - ScrMatch
```
protected int ScrMatch()
```
    Matches the screen with all the screen identities.
    The return value specifies a number of screens that match. Then use the function ScrGetNext to find the name of the screens.
    
    See Also:
    
    ScrGetNext()
  - ScrGetNext
```
protected String ScrGetNext()
```
    Retrieves the name of the next matching screen identity after ScrMatch.
    Returns empty string if no more screens matches.
    
    See Also:
    
    ScrMatch()
  - PanCreate
```
protected int PanCreate(String panelID)
                 throws IllegalArgumentException
```
    Creates a new panel.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanDestroy(), PanPreload(java.lang.String)
  - PanPreload
```
protected int PanPreload(String panelID)
                  throws IllegalArgumentException
```
    Preloads a panel the same way as when next panel is connected to a push button or a menu item.
    rc = PanPreload("*"); can be specified. It can also be used to turn notebook pages, i.e. to specify the notebook page ID.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanCreate(java.lang.String), PanDestroy()
  - PanProcess
```
protected String PanProcess()
```
    Starts processing a panel.
    The function does not return until the function PanEnd has been called with a certain string or the panel itself is closed by the user, leading to the application being terminated.
    This function can only be used from a REXX application.
    Return value:
```
   String  String sent to the function PanEnd
   CLOSE   This string is returned when NetPhantom is en route to
           being exited.
 
```
    See Also:
    
    PanEnd(java.lang.String)
  - PanEnd
```
protected int PanEnd(String string)
```
    Exits a PanProcess function issued from another thread with string.
    PanEnd signals an event for a REXX application waiting on PanProcess. PanProcess will wait until it receives the string from PanEnd after which the application will continue using the contents of that string. Normally it is a REXX application that issues PanProcess and a Java macro that calls PanEnd.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    PanProcess()
  - PanDestroy
```
protected int PanDestroy()
```
    Removes or destroys the topmost panel.
    Note: a main panel cannot be destroyed.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    PanCreate(java.lang.String), PanPreload(java.lang.String)
  - PanRemove
```
protected int PanRemove()
```
    Removes or destroys the topmost panel.
    
    See Also:
    
    PanDestroy()
  - PanHostInhibit
```
protected int PanHostInhibit(int inhibitState)
                      throws IllegalArgumentException
```
    Removes or restores panel processing between NetPhantom and the terminal session.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Example:
    Removes panel processing, send enter to host to go next host screen, retrieve the control FLDNAME and then send PF3 to get back to the first host screen (no check for errors).
```
   PanHostInhibit(1);
   PanLock(1);
   int rc = HostSend("@E");
   rc = HostWait();
   String fldname = HostGetFld(null,"FLDNAME");
   rc = HostSend("@3");
   rc = HostWait();
   PanHostInhibit(0);
   PanLock(0);
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanLock(int)
  - PanLock
```
protected int PanLock(int lockState)
               throws IllegalArgumentException
```
    Locks or restores user panel processing.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Example:
    Remove host and user processing, execute code and then restore all.
```
   PanHostInhibit(1); // Must be first!
   PanLock(1);
   ...code...
   PanHostInhibit(0);
   PanLock(0);
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanHostInhibit(int)
  - PanSetCtlData
```
protected int PanSetCtlData(String controlID,
                            String data)
                     throws IllegalArgumentException
```
    Sets the contents of a panel control.
    If ControlID is *PANEL the text for the current panel is set. If it is *APP the text for the application panel is set.
    This function can also be used for image handling. See Chapter 6 Image Handling in the Developers Reference.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanGetCtlData(java.lang.String)
  - PanGetCtlData
```
protected String PanGetCtlData(String controlID)
                        throws IllegalArgumentException
```
    Retrieves the contents of a panel control.
    If ControlID is *PANEL, the text for the current panel is retrieved. If it is *APP the text for the application panel is retrieved.
    This function can also be used for image handling. See Chapter 6 Image Handling in the Developers Reference.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanSetCtlData(java.lang.String, java.lang.String)
  - PanSetCtlStyle
```
protected int PanSetCtlStyle(String controlID,
                             int style)
                      throws IllegalArgumentException
```
    Sets style of panel control.
    This also works on the panel's menu items. If an asterisk (*) is typed before the control ID, the application panel's menu item with this ID will be processed instead.
    style:
```
   0  Disable the control.
   1  Enable the control.
   2  Hide the control (this does not work for menus).
   3  Show the control (this does not work for menus).
 
```
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanGetCtlStyle(java.lang.String)
  - PanGetCtlStyle
```
protected int PanGetCtlStyle(String controlID)
                      throws IllegalArgumentException
```
    Retrieves a control style.
    This also works on the panel's menu items. If an asterisk (*) is typed before the control ID, the application panel's menu item with this ID will be processed instead.
    Return value:
```
   0  Control disabled.
   1  Control enabled.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanSetCtlStyle(java.lang.String, int)
  - PanSetCtlClr
```
protected int PanSetCtlClr(String controlID,
                           int foreground,
                           int background)
                    throws IllegalArgumentException
```
    This function set or removes the colors of a control.
    Set the color to 0=no change, 127=restore to normal or 1-30.
    The color can be the foreground and/or the background color. If foreground or background is set to 0 (zero), that color will be left as it was previously, e.g. will not be set. To remove one or both of the colors, e.g. to restore the color to default, set it to 127.
    For the list of colors for the controls see Appendix G Graphical Control Colors in the Developers Reference.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
  - PanListInsertData
```
protected int PanListInsertData(String controlID,
                                int line,
                                String data)
                         throws IllegalArgumentException
```
    Adds or inserts a line of Data in a list.
    The line will be inserted before the line. If lines should be added at the end of the list set line to 0. If the list contains several columns these should be separated using the Tab character (ASCII value 9).
    If a list column has foreground or background color attributes, the column data must be preceded by two characters, foreground and background color index, respectively. See Appendix G Graphical Control Colors in the Developers Reference.
    This function can also be used with combination boxes.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListDelete(java.lang.String, int), PanListClear(java.lang.String), PanListSetData(java.lang.String, int, java.lang.String), PanListSetFld(java.lang.String, int, int, java.lang.String)
  - PanListDelete
```
protected int PanListDelete(String controlID,
                            int line)
                     throws IllegalArgumentException
```
    Deletes a line (1-nn) from a list.
    This function can also be used with combination boxes.
    Return value:
```
   nn  Number of lines remaining in the list box or combination box.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListClear(java.lang.String), PanListInsertData(java.lang.String, int, java.lang.String)
  - PanListClear
```
protected int PanListClear(String controlID)
                    throws IllegalArgumentException
```
    Clears a list of all its contents.
    This function can also be used with combination boxes.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListDelete(java.lang.String, int), PanListInsertData(java.lang.String, int, java.lang.String)
  - PanListSetSel
```
protected int PanListSetSel(String controlID,
                            int line,
                            int selectionState)
                     throws IllegalArgumentException
```
    Selects or deselects a line in a list.
    The range for line is 1 up to the number of lines in the list (inclusive). If Line is set to 0 (zero), the last line will be selected.
    This function can also be used with combination boxes.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListGetSel(java.lang.String, int)
  - PanListGetSel
```
protected int PanListGetSel(String controlID,
                            int prevLine)
                     throws IllegalArgumentException
```
    Retrieves the next selected line in a list or zero if no more selections exists.
    The list search is based on prevLine. If this is 0 the search starts from the first line. If it is greater than 0, the search is started on the line following the prevLine specified.
    This function can also be used with combination boxes.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListSetSel(java.lang.String, int, int)
  - PanListGetData
```
protected String PanListGetData(String controlID,
                                int lineNo)
                         throws IllegalArgumentException
```
    Retrieves the contents of a line (1-nn) in a list.
    If the list contains several columns the returned string will contain the Tab character (ASCII value 9) between each column.
    If a list column has foreground or background color attributes, the column data is preceded by two characters, i.e. the foreground and background color index, respectively. See Appendix G Graphical Control Colors in the Developers Reference.
    This function can also be used with combination boxes.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListGetFld(java.lang.String, int, int), PanListSetData(java.lang.String, int, java.lang.String), PanListInsertData(java.lang.String, int, java.lang.String)
  - PanListFromFile
```
protected int PanListFromFile(String controlID,
                              String fileName)
                       throws IllegalArgumentException
```
    Fills a list with data from a text file.
    Each line in the file will therefore form a line in the list. The list will not be cleared before the file data is added to the end of the list. If the list contains several columns, the lines in the file should contain the Tab character (ASCII value 9) between each column.
    If a list column has foreground or background color attributes, the column data must be preceded by two characters, i.e. the foreground and background color index, respectively. See Appendix G Graphical Control Colors in the Developers Reference.
    This function can also be used with combination boxes.
    Return value:
```
   0  OK.
   1  Error.
   5  Error, file not found.
   6  Error, read error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListToFile(java.lang.String, java.lang.String), PanComboFromFile(java.lang.String, java.lang.String)
  - PanListToFile
```
protected int PanListToFile(String controlID,
                            String fileName)
                     throws IllegalArgumentException
```
    Stores the contents of a list into a text file.
    Each line in the list will therefore form a line in the file. If the file already exists, it will be replaced. It will be written in OEM ASCII text character set. If the list contains several columns, the lines in the file contain the tab character (ASCII value 9) between each column.
    If a list column has foreground and background color attributes, the column data will be preceded by two characters, i.e. the foreground and background color index, respectively. See Appendix G Graphical Control Colors in the Developers Reference.
    This function can also be used with combination boxes.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListFromFile(java.lang.String, java.lang.String), PanComboFromFile(java.lang.String, java.lang.String)
  - PanListGetFld
```
protected String PanListGetFld(String controlID,
                               int lineNo,
                               int columnNo)
                        throws IllegalArgumentException
```
    Function to retrieve a list field (a line [1-nn] and a column [1-columnCount]).
    This is a function that is used to retrieve a field (line and column) from a list without having to search for the tab characters to find the column.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListSetFld(java.lang.String, int, int, java.lang.String), PanListGetData(java.lang.String, int)
  - PanListSetFld
```
protected int PanListSetFld(String controlID,
                            int lineNo,
                            int columnNo,
                            String data)
                     throws IllegalArgumentException
```
    Function to set a list field (a line [1-nn] and a column [1-columnCount]).
    This function can be used instead of PanListSetData when one column in a list should be updated.
    If a list column has foreground or background color attributes, the column data must be preceded by two characters, foreground and background color index, respectively. See Appendix G Graphical Control Colors in the Developers Reference.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListInsertData(java.lang.String, int, java.lang.String), PanListSetData(java.lang.String, int, java.lang.String), PanListGetFld(java.lang.String, int, int)
  - PanListSetData
```
protected int PanListSetData(String controlID,
                             int lineNo,
                             String data)
                      throws IllegalArgumentException
```
    Update a line in a list.
    This function should be used for lists with one column, or when all columns in a line should be updated, otherwise use PanListSetFld.
    If a list column has foreground or background color attributes, the column data must be preceded by two characters, foreground and background color index, respectively. See Appendix G Graphical Control Colors in the Developers Reference.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListInsertData(java.lang.String, int, java.lang.String), PanListSetFld(java.lang.String, int, int, java.lang.String)
  - PanListGetNum
```
protected int PanListGetNum(String controlID)
                     throws IllegalArgumentException
```
    Get number of lines in a list.
    This function can also be used with combination boxes.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListInsertData(java.lang.String, int, java.lang.String)
  - PanCheckSet
```
protected int PanCheckSet(String controlID,
                          int checkState)
                   throws IllegalArgumentException
```
    Sets the selection of a radio button or check box.
    The control ID is for radio button or check box. This also works on the panel's menu items. If an asterisk (*) is typed before the control ID, the application panel's menu item with this ID will be processed instead.
    Return value:
```
   0  OK.
   1  Error, unable to select.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanCheckGet(java.lang.String)
  - PanCheckGet
```
protected int PanCheckGet(String controlID)
                   throws IllegalArgumentException
```
    Retrieves the selection of a radio button or check box.
    The control ID is for radio button or check box. This also works on the panel's menu items. If an asterisk (*) is typed before the control ID, the application panel's menu item with this ID will be processed instead.
    Return value:
```
   0  Control is unchecked.
   1  Control is checked.
   2  Control is in third state.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanCheckSet(java.lang.String, int)
  - PanGetText
```
protected String PanGetText(String textID)
                     throws IllegalArgumentException
```
    Retrieves a text from the current text file.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanXlate(java.lang.String)
  - PanXlate
```
protected String PanXlate(String text)
```
    Translates the string using the current translation table.
    The string is empty if no matching translation is found.
    
    See Also:
    
    PanGetText(java.lang.String)
  - PanSetFocus
```
protected int PanSetFocus(String controlID,
                          int selectControl)
                   throws IllegalArgumentException
```
    Sets focus to a panel control. selectControl can be 0 or 1 if the control should be selected.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanSelectCurrCtl()
  - PanSelectCurrCtl
```
protected int PanSelectCurrCtl()
```
    This function selects the current entry field.
    E.g. it is used to show the user that an error message has occurred.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    PanSetCurFromHost(), PanSetPanelFromHost(java.lang.String[])
  - PanUpdate
```
protected int PanUpdate()
```
    Updates all controls and menus in the panel in respect to text and translation files and the current host screen.
    This function should be called when the text and/or translation file is swapped. A panel with static texts, prompts, headers, etc., connected to host fields is not updated when the host changes, only when the panel is created the first time or when the panel becomes active again! In cases where one wants to update these controls, use this function. However, do not call PanUpdate from an object that is processing a HostChange (HCHG) message. The function PanUpdate sends a HostChange directly after it is completed.
    Warning: If a call to PanUpdate is made from a HostChange (HCHG) this will cause the program to loop.
    Return value:
```
   0  OK.
   1  Error.
 
```
  - PanSetCurFromHost
```
protected int PanSetCurFromHost()
```
    Places the cursor in the panel in the same position it has in the terminal session.
    Return value:
```
   0  OK.
   1  Error, unable to position cursor.
 
```
    See Also:
    
    PanSetPanelFromHost(java.lang.String[]), PanSelectCurrCtl()
  - PanSetPanelFromHost
```
protected int PanSetPanelFromHost(String[] panels)
                           throws IllegalArgumentException
```
    Sets the correct panel from the current cursor position. It can also be panels that are not loaded yet. The function checks all panels that are connected to the current screen to see if there is a field that matches the control. The parameters for the function are a list of panels that are host connected but have no specific host screen connected to them. NetPhantom does not know to which screen they are connected. If this is the case, specify the panel IDs for these panels as the parameters for the function.
    Once the correct panel has been found containing a control at the current host cursor position, the panel will be loaded and shown (if not already there) and the cursor position will be placed accordingly in the panel.
    Return value:
```
   0  OK.
   1  Error.
   8  Unable to find a panel that matches the host field position.
   9  Unable to find the current host field related to the cursor position.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanSetCurFromHost(), PanSelectCurrCtl()
  - PanChart
```
protected String PanChart(String controlID,
                          String function,
                          String data)
                   throws IllegalArgumentException
```
    Function for processing graphical charts.
    For a list of functions, data and return values, see the Business Graphics section in the Developers Reference.
    Return value:
```
   0      OK.
   9      Error, control not found.
   other  See the NetPhantom documentation.
 
```
    Throws:
    
    IllegalArgumentException
  - PanComboFromFile
```
protected int PanComboFromFile(String controlID,
                               String fileName)
                        throws IllegalArgumentException
```
    Fills a combination box with contents of a text file.
    The text file can have one or two columns separated by a tab char (ASCII character 9). It will be written in OEM ASCII text character set. If it consists of only one column, it contains texts that will be presented in the combination box. If made up of two columns, the first column is the host conversion code and the second column is the text that will be presented in the combination box (e.g. "05[tab]This is the text").
    Return value:
```
   0  OK.
   1  Error.
   5  Error, file not found.
   6  Error, read error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanListFromFile(java.lang.String, java.lang.String)
  - PanGetCurrPanel
```
protected String PanGetCurrPanel()
```
    Retrieves the name of the current panel.
    
    Returns:
    
    null if no panel is current.
  - PanCallCtl
```
protected int PanCallCtl(String controlID)
                  throws IllegalArgumentException
```
    Activates a menu item or a push button with control ID controlID. Control IDs may reference a control on any created panel.
    Return value:
```
   0  OK.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
  - PanFormatText
```
protected String PanFormatText(String text)
```
    Parses string to resolve @-sequences.
    Other text in the string is not affected, except for literal @-characters. Returns the resolved string string. @-sequences make it possible to read host fields, get text strings from the text file, use translation tables and read global variables and special variables with system information.
    For more information on @-sequences in strings, see 8.4 Special Functions for Text Strings in the User's Guide. The sequence @**PANELID@ cannot be used from a program object.
    
    See Also:
    
    PanGetText(java.lang.String), PanXlate(java.lang.String)
  - PanGetDllExt
```
protected String PanGetDllExt(String name)
```
    Get a system dependent extension of a file name.
    The purpose of this function is to add 'NT', 'W3' or '32' to a dllName stub, for example 'PHBUT', if and only if the Add extension box is checked (in Application data). No file name extension (.DLL) should be included. If the dllName is longer than six characters it will be truncated to six characters before the extension is appended.
    Because the NetPhantom Java environment is system independent, no string will be added as opposed to the Phantom Runtime for Windows NT/95, OS/2 or Windows 3.1.
  - PanNbCancelPaging
```
protected int PanNbCancelPaging()
```
    Cancels notebook paging when a user has selected a notebook page that is not the Next or the Previous one.
    This function is used when the host system has the possibility of jumping to the required page directly or if paging needs to be interrupted due to, for example, an error situation.
    When a user presses a notebook tab, the object connected to the action of the page(s) is started until an error occurs. If the object runs in a separate thread, i.e. is a Java Application, special care must be taken because multiple threads might be started. The preferred Java object type is Java Macro because it is started synchronously within the same thread as the NetPhantom client session.
    There is no need to lock the panel or to turn off processing when this function is used. When a notebook tab is clicked, just cancel paging when the transaction is sent.
    When a user selects a notebook tab, NetPhantom normally will start to turn pages one by one until the desired page is reached, using the defined prev/next actions. This function will prevent this from happening, which makes it possible to use a single object to turn pages.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Example:
    The host supports direct access to any notebook page. The object is defined as a Java Macro.
```
   if ( argMsg != CMD )
     return;
   // Get the page index of the destination.
   String dest = Word(argStr,1);
   // Command Jnn jumps to page nn
   int rc = HostSetFld(null, "PAGEJUMP", "J"+dest);
   rc = HostSend("@E");
   rc = PanNbCancelPaging();
 
```
    Example:
    The host requires a send key F7 or F8 for each page. This is normally handled by NetPhantom, but we want some extra error checking.
```
   if ( argMsg != CMD )
     return;
     
   // We do the error checking now
   String errMsg = DoOurErrorChecking();
   if ( !errMsg.isEmpty() )
     {
     PanNbCancelPaging();
     Message(2, 2, errMsg);
     return;
     }
     
   // Get the function key to send: F7 or F8
   String dest = Word(string, 1);
   String prev = Word(string, 5);
   String sendKey;
   if ( dest.compareTo(prev) < 0 )
     sendKey = "@7";
   else
     sendKey = "@8";
     
   int rc = HostSend(sendKey);
   return;
 
```
  - PanGetCurrNbPage
```
protected String PanGetCurrNbPage(String controlID)
                           throws IllegalArgumentException
```
    Get the current notebook page.
    The controlID can be set to null if there is just one notebook in the topmost panel.
    The string is empty if there is no current notebook page or the notebook cannot be found.
    
    Throws:
    
    IllegalArgumentException
  - PanSetTextFile
```
protected int PanSetTextFile(String fileName)
                      throws IllegalArgumentException
```
    Swaps the current text file for the specified file name.
    The file name should be specified without an extension (which will be .PHM). The file name may be up to 8 characters in length
    Returns
```
    0 = OK.
    1 = Error, unable to load file.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanGetText(java.lang.String)
  - PanSetXlateFile
```
protected int PanSetXlateFile(String fileName)
                       throws IllegalArgumentException
```
    Swaps the current translation file for the specified file name.
    The file name should be specified without an extension (which will be .PHX). The file name may be up to 8 characters in length
    Returns
```
    0 = OK.
    1 = Error, unable to load file.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanXlate(java.lang.String)
  - PanGetFocus
```
protected String PanGetFocus()
```
    Get the current panel/control that has focus or empty string if focus not could be found.
  - PanGetCtlLen
```
protected int PanGetCtlLen(String controlID)
```
    Get the length of a panel control. This method only works with some controls.
    Returns
```
    1-nn = length.
    0    = Error, control not found or length not supported by control.
 
```
  - PanSetCtlLen
```
protected int PanSetCtlLen(String controlID,
                           int length)
```
    Set the length of a panel control. This method only works with some controls.
    Returns
```
    0  = OK.
    1 = Error, length not supported by control.
    9 = Error, control not found.
 
```
  - SessionStart
```
protected int SessionStart(String sessionID)
                    throws IllegalArgumentException
```
    Starts a new main panel session for an application panel.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    SessionStop(java.lang.String)
  - SessionSelect
```
protected int SessionSelect(String sessionID)
                     throws IllegalArgumentException
```
    Places the session in the foreground of all panel sessions.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    SessionStart(java.lang.String)
  - SessionStop
```
protected int SessionStop(String sessionID)
                   throws IllegalArgumentException
```
    Stops a panel session. A panel session cannot be stopped by a user, but must be stopped by the application program. However, a message concerning the fact that the user wishes to stop the session is obtained. The SessionStop function should then be called.
    Return value:
```
   0  OK.
   1  Error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    SessionStart(java.lang.String)
  - SessionExit
```
protected int SessionExit()
```
    Exits the current client session. The connection to the client will be closed and the terminal session stopped. The session will then be restarted for use by another client session.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    PanelExit()
  - PanelExit
```
protected int PanelExit()
```
    Exits the current client session. The connection to the client will be closed and the terminal session stopped. The session will then be restarted for use by another client session.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    SessionExit()
  - SessionGet
```
protected String SessionGet()
```
    Retrieves the session that is in the foreground. The returned string is the session ID for the foreground session. An empty string indicates an error.
    
    See Also:
    
    SessionGetAll()
  - SessionGetAll
```
protected String SessionGetAll()
```
    Retrieves all the sessions that have been started. The returned string is the session IDs for all sessions, separated by spaces. An empty string indicates an error or that no sessions have been started.
    
    See Also:
    
    SessionGet()
  - ClipbrdGet
```
protected String ClipbrdGet()
```
    This method get the clipboard data from the client. The text may contain several lines. These are separated by CR+LF (ASCII values 13 and 10 respectively). Note that this method must be called from within a separate thread (REXX Application).
    Return value:
```
   data     Clipboard data or empty string.
 
```
  - ClipbrdSet
```
protected int ClipbrdSet(String data)
```
    This method set the clipboard on the client.
    Parameters:
```
   data       Data to send to clipboard.
 
```
    Return value:
```
   0  No error.
   1  Error.
 
```
  - TimerStart
```
protected int TimerStart(int timerNo)
```
    Starts a timer (1-9). If the timer has been started previously, it will be started again from the beginning. If it is in pause mode it will resume measurement.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    TimerStop(int), TimerPause(int), TimerGet(int)
  - TimerPause
```
protected int TimerPause(int timerNo)
```
    Pauses a timer (1-9). If the timer has been started previously, it will be put into pause mode. It can be restarted using the function TimerStart. To restart a timer from zero it must first be stopped using the function TimerStop.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    TimerStart(int), TimerStop(int), TimerGet(int)
  - TimerStop
```
protected int TimerStop(int timerNo)
```
    Stops a timer (1-9). If the timer has been stopped previously, this call will be ignored. If the timer might need to be restarted from the current time later, the function TimerPause should be used. The timer can then be started using TimerStart.
    Return value:
```
   0  OK.
   1  Error.
 
```
    See Also:
    
    TimerStart(int), TimerPause(int), TimerGet(int)
  - TimerGet
```
protected String TimerGet(int timerNo)
```
    Returns the current reading on a timer (1-9) in hundredth of seconds. If the timer has not been stopped, the time that has elapsed is returned. For invalid timer number, zero is returned.
    
    See Also:
    
    TimerStart(int), TimerPause(int), TimerStop(int)
  - CompLine
```
protected int CompLine(int line,
                       String string)
                throws IllegalArgumentException,
                       NumberFormatException
```
    This method compares a text string containing wildcards with a line on the host screen.
    Parameters:
```
   line    Host line number(1-nn).
   string  String to compare with host.
   timer   Timer to stop (1-9, 0 = no timer).
 
```
    Return Value:
```
   0  No error.
   1  Communication error with host.
   4  String not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    NumberFormatException
    
    See Also:
    
    WCompLine(int, java.lang.String, int), CompPos(int, int, java.lang.String), CompScreen(java.lang.String)
  - WCompLine
```
protected int WCompLine(int line,
                        String string,
                        int timer)
                 throws IllegalArgumentException,
                        NumberFormatException
```
    This method compares a text string containing wildcards with a line on the host screen. If a timer should be stopped, this can be specified as the final parameter.
    This method waits for the host to compare with string. It is not possible to use this method from a REXX macro.
    Parameters:
```
   line    Host line number(1-nn).
   string  String to compare with host.
   timer   Timer to stop (1-9, 0 = no timer).
 
```
    Return Value:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    NumberFormatException
    
    See Also:
    
    CompLine(int, java.lang.String), WCompPos(int, int, java.lang.String, int), WCompScreen(java.lang.String, int)
  - CompPos
```
protected int CompPos(int line,
                      int column,
                      String string)
               throws IllegalArgumentException,
                      NumberFormatException
```
    This method compares a text string without wildcards with a certain position (line and column) on the host screen. If a timer should be stopped, this can be specified as the final parameter.
    Parameters:
```
   line    Host line number(1-nn).
   column  Host column number (1-nn).
   string  String to compare with host.
   timer   Timer to stop (1-9, 0 = no timer).
 
```
    Return Value:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
   4  String not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    NumberFormatException
    
    See Also:
    
    WCompPos(int, int, java.lang.String, int), CompLine(int, java.lang.String), CompScreen(java.lang.String)
  - WCompPos
```
protected int WCompPos(int line,
                       int column,
                       String string,
                       int timer)
                throws IllegalArgumentException,
                       NumberFormatException
```
    This method compares a text string without wildcards with a certain position (line and column) on the host screen. If a timer should be stopped, this can be specified as the final parameter.
    This method waits for the host to compare with string. It is not possible to use this method from a REXX macro.
    Parameters:
```
   line    Host line number(1-nn).
   column  Host column number (1-nn).
   string  String to compare with host.
   timer   Timer to stop (1-9, 0 = no timer).
 
```
    Return Value:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    NumberFormatException
    
    See Also:
    
    CompPos(int, int, java.lang.String), WCompLine(int, java.lang.String, int), WCompScreen(java.lang.String, int)
  - CompScreen
```
protected int CompScreen(String string)
                  throws IllegalArgumentException,
                         NumberFormatException
```
    This method compares a text string containing wildcards with the entire host screen. If a timer should be stopped, this can be specified as the final parameter.
    Parameters:
```
   string  String to compare with host.
   timer   Timer to stop (1-9, 0 = no timer).
 
```
    Return Value:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
   4  String not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    NumberFormatException
    
    See Also:
    
    WCompScreen(java.lang.String, int), CompLine(int, java.lang.String), CompPos(int, int, java.lang.String)
  - WCompScreen
```
protected int WCompScreen(String string,
                          int timer)
                   throws IllegalArgumentException,
                          NumberFormatException
```
    This method compares a text string containing wildcards with the entire host screen. If a timer should be stopped, this can be specified as the final parameter.
    This method waits for the host to compare with string. It is not possible to use this method from a REXX macro.
    Parameters:
```
   string  String to compare with host.
   timer   Timer to stop (1-9, 0 = no timer).
 
```
    Return Value:
```
   0  No error.
   1  Communication error with host.
   2  Time-out.
 
```
    Throws:
    
    IllegalArgumentException
    
    NumberFormatException
    
    See Also:
    
    CompScreen(java.lang.String), CompLine(int, java.lang.String), CompPos(int, int, java.lang.String)
  - DdeExecute
```
protected int DdeExecute(int dde_nn,
                         String command)
                  throws IllegalArgumentException
```
    This function sends the DDE verb EXECUTE to the application and the subject that is initiated to dde_nn.
    Parameters:
```
   dde_nn     Handle retrieved from DdeInitiate.
   Location   Location (e.g. position in Excel sheet).
   Data       Data to EXECUTE.
 
```
    Return Value:
```
   0            OK.
   1          DDE communication error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    DdeInitiate(java.lang.String, java.lang.String), XDdeInitiate(java.lang.String, java.lang.String, java.lang.String), DdePoke(int, java.lang.String, java.lang.String), XDdePoke(int, java.lang.String, java.lang.String), DdeTerminate(int), XDdeTerminate(int)
  - DdeInitiate
```
protected int DdeInitiate(String programName,
                          String subject)
                   throws IllegalArgumentException
```
    This function requests communication with the program ProgramName with the subject Subject.
    Parameters:
```
    ProgramName   Name of the program to be communicated with.
    Subject       String subject (e.g. Excel sheet).
 
```
    Return Value:
```
    0         Error.
    dde_nn  Handle for this conversation. The handle is a numeric value 
            which should be used for further communication.
 
```
    Example:
    Example Initiate a DDE communication with the Excel sheet DEMO.XLS
```
   excel = DdeInitiate('Excel','DEMO.XLS')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    DdeExecute(int, java.lang.String), XDdeExecute(int, java.lang.String), DdePoke(int, java.lang.String, java.lang.String), XDdePoke(int, java.lang.String, java.lang.String), DdeTerminate(int), XDdeTerminate(int)
  - DdePoke
```
protected int DdePoke(int dde_nn,
                      String location,
                      String data)
               throws IllegalArgumentException
```
    This function sends the DDE verb POKE to the application and subject which is initiated to dde_nn.
    Parameters:
```
    dde_nn    Number retrieved from DdeInitiate.
    Location  Location (e.g. position in Excel sheet).
    Data      Data to EXECUTE.
 
```
    Return Value:
```
    0           OK.
    1         DDE communication error.
 
```
    Example:
    Send the value 123 to the Excel sheet EXAMPLE.XLS row 2 column 4.
```
   rc = DdePoke(excel,'R2C4','123')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    DdeExecute(int, java.lang.String), XDdeExecute(int, java.lang.String), DdeInitiate(java.lang.String, java.lang.String), XDdeInitiate(java.lang.String, java.lang.String, java.lang.String), DdeTerminate(int), XDdeTerminate(int)
  - DdeTerminate
```
protected int DdeTerminate(int dde_nn)
                    throws IllegalArgumentException
```
    This function exits communication with the DDE session dde_nn.
    Parameters:
```
    dde_nn    Handle retrieved from DdeInitiate.
 
```
    Return Value:
```
    0           OK.
    1         DDE communication error.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    DdeExecute(int, java.lang.String), XDdeExecute(int, java.lang.String), DdeInitiate(java.lang.String, java.lang.String), XDdeInitiate(java.lang.String, java.lang.String, java.lang.String), DdePoke(int, java.lang.String, java.lang.String), XDdePoke(int, java.lang.String, java.lang.String)
  - XDdeAdvise
```
protected int XDdeAdvise(int hConv,
                         String item,
                         int flags)
                  throws IllegalArgumentException
```
    This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv send the data connected to Item every time it changes. Flags indicate the methods the server uses in order to notify the calling object that an item has changed. If the application that serves the conversation does not accept the request, a DDEERR REJECTED message is sent to the calling object. If an error occurs during the processing of the request, a DDEERR ERROR is sent to the calling object. If the serving application fails to acknowledge the request, a DDEERR TIMEOUT message is sent to the calling object. If the serving application accepts the request, a DDEERR ACCEPTED is sent to the calling object.
    Parameters:
```
    hConv   Numeric value that identifies the requested DDE conversation.

    Item    String that identifies the item within a conversation.

    Flags   Flags indicating the method to use.
 
      0     Update changed data with a DDEDATA UPDATE message.
      2     Update changed data with a DDEDATA UPDATE message after which the DDE 
            Engine will acknowledge reception of that data. This method might be 
            useful if the data changes very rapidly causing flooding of the message
            queue.
      4     Signal that a data item has changed by sending a DDEDATA UPDATE message
            without the data. This method is used if the calling object wants to 
            control when the update is performed. The calling object can request the
            data after receiving the signal by calling XDdeRequest.
 
 
```
    Return Value:
```
    0       Request not submitted (Error).
    hReq    Request handle. This request handle identifies the advise link.
 
```
    Example:
    Request to be updated every time the data from cell R4C2 in a Excel sheet changes.
```
   hrAdv = XDdeAdvise(hcExcel, 'R4C2', '0')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdeUnadvise(int, int), XDdeRequest(int, java.lang.String)
  - XDdeExecute
```
protected int XDdeExecute(int hConv,
                          String command)
                   throws IllegalArgumentException
```
    This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv execute the Command. If the application that serves the conversation does not accept the request, a DDEERR REJECTED message is sent to the calling object. If an error occurs during the processing of the request, a DDEERR ERROR is sent to the calling object. If the serving application fails to acknowledge the request, a DDEERR TIMEOUT message is sent to the calling object. If the serving application accepts the request, a DDEERR ACCEPTED is sent to the calling object.
    Parameters:
```
   hConv      Handle that identifies the requested DDE conversation.
   Command    Command string.
 
```
    Return Value:
```
    0         Request not submitted (Error).
    hReq      Request handle.
 
```
    Example:
    Let SERVER.EXE execute the command 'OPEN REPORT'.
```
   hReq = XDdeExecute(hcServer, 'OPEN REPORT')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdePoke(int, java.lang.String, java.lang.String)
  - XDdeInitiate
```
protected int XDdeInitiate(String progName,
                           String topicName,
                           String objectName)
                    throws IllegalArgumentException
```
    This functions initiates the requested DDE conversation. The DDE Engine will notify the calling object once the requested conversation is established by sending a DDECONN MADE message. Note that this message comes in before the XDdeInitiate returns.
    Parameters:
```
    ProgName    (DDE) name of the application that serves the requested conversation.
    TopicName   Name of the topic that identifies the conversation topic.
    ObjectName  Name of the calling object. This name is needed by the DDE Engine to 
                dispatch notification messages.
 
```
    Return Value:
```
    0       No conversation established.
    hConv   Conversation handle. The handle is a numeric value that identifies the requested DDE conversation. Every incoming DDE client message (DDECONN, DDEERR, DDEDATA) will pass this handle for verification. 
 
```
    Example:
    Establish a DDE conversation with the Excel sheet 'DEMO.XLS'
```
   hcExcel = XDdeInitiate('Excel', 'DEMO.XLS', 'DEMO')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdeTerminate(int)
  - XDdePoke
```
protected int XDdePoke(int hConv,
                       String item,
                       String data)
                throws IllegalArgumentException
```
    This functions submits a request to the DDE Engine to poke the unsolicited Data to the Item in the conversation identified by hConv. If the application that serves the conversation does not accept the request, a DDEERR REJECTED message is sent to the calling object. If an error occurs during the processing of the request, a DDEERR ERROR is sent to the calling object. If the serving application fails to acknowledge the request, a DDEERR TIMEOUT message is sent to the calling object. If the serving application accepts the request, a DDEERR ACCEPTED is sent to the calling object.
    Parameters:
```
    hConv     Handle that identifies the requested DDE conversation.
    Item      String that identifies the item within a conversation.
    Data      Data string.
 
```
    Return Value:
```
    0       Request not submitted (Error).
    hReq    Request handle.
 
```
    Example:
    Set the value in cell R2C3 of an Excel sheet to 42.
```
   hReq = XDdePoke(hcExcel, 'R2C3', '42')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdeExecute(int, java.lang.String)
  - XDdeRequest
```
protected int XDdeRequest(int hConv,
                          String item)
                   throws IllegalArgumentException
```
    This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv send the data connected to Item. If the application that serves the conversation does not accept the request, a DDEERR REJECTED message is sent to the calling object. If an error occurs during the processing of the request, a DDEERR ERROR is sent to the calling object. If the serving application fails to acknowledge the request, a DDEERR TIMEOUT message is sent to the calling object. If the serving application accepts the request, a DDEDATA DATA is sent to the calling object. The requested data is enclosed in this message.
    Parameters:
```
    hConv     Handle that identifies the requested DDE conversation.
    Item      String that identifies the item within a conversation.
 
```
    Return Value:
```
    0         Request not submitted (Error).
    hReq      Request handle.
 
```
    Example:
    Request the data from cell R4C2 in an Excel sheet.
```
   hReq = XDdeRequest(hcExcel, 'R4C2')
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdeInitiate(java.lang.String, java.lang.String, java.lang.String)
  - XDdeTerminate
```
protected int XDdeTerminate(int hConv)
                     throws IllegalArgumentException
```
    This functions submits a request to the DDE Engine to terminate the DDE conversation identified by hConv. The DDE Engine will notify the calling object when the conversation is dropped with a DDECONN DROPPED message. The DDE Engine will finish all requests that precede the terminate request in the request queue connected to the conversation. Once the terminate request is in process, all incoming DDE messages are ignored. All requests submitted for the conversation after a terminate request are discarded. If an error occurs during the processing of the request, a DDEERR ERROR message is sent to the calling object.
    Parameters:
```
    hConv     Handle that identifies the requested DDE conversation.
 
```
    Return Value:
```
    0           Request submitted.
    non-zero    Request not submitted (Error).
 
```
    Example:
    Terminate the DDE conversation identified by hcExcel.
```
   rc = XDdeTerminate(hcExcel)
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdeInitiate(java.lang.String, java.lang.String, java.lang.String)
  - XDdeUnadvise
```
protected int XDdeUnadvise(int hConv,
                           int hReq)
                    throws IllegalArgumentException
```
    This function submits a request to the DDE Engine to have the application that serves the conversation identified by hConv terminate the advise link identified by hReq. If the application that serves the conversation does not accept the request, a DDEERR REJECTED message is sent to the calling object. If an error occurs during the processing of the request, a DDEERR ERROR message is sent to the calling object. If the serving application fails to acknowledge the request, a DDEERR TIMEOUT message is sent to the calling object. If the serving application accepts the request, a DDEERR ACCEPTED message is sent to the calling object. Note that the DDEERR message will be identified by hReq. Only XDdeUnadvise reuses the request handle.
    Parameters:
```
    hConv     Handle that identifies the requested DDE conversation.
    hReq      Request handle. This request handle identifies the advise link.
 
```
    Return Value:
```
    0           Request submitted.
    non-zero    Request not submitted (Error). This function does not return a request handle because it reuses the hReq request handle passed in the call.
 
```
    Example:
    Terminate the advise link for cell R4C2 in an Excel sheet.
```
   rc = XDdeUnadvise(hcExcel, hrAdv)
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    XDdeAdvise(int, java.lang.String, int)
  - XDdeUpdate
```
protected int XDdeUpdate(String topic,
                         String item,
                         String data)
                  throws IllegalArgumentException
```
    This functions notifies the DDE Engine that the data for Topic, item has changed to Data. The DDE Engine will update the relevant connected clients.
    Parameters:
```
    Topic     Topic string.
    Item      Item string.
    Data      Data string.
 
```
    Return Value:
```
    0         OK.
    non-zero  Error.
 
```
    Example:
    Update the data for topic 'STATUS' item 'PROC1' that changed to 'READY'.
```
   rc = XDdeUpdate('STATUS', 'PROC1', 'READY')
 
```
    Throws:
    
    IllegalArgumentException
  - FileCreate
```
protected int FileCreate(String fileName)
                  throws IllegalArgumentException
```
    Creates an empty file with the name fileName. If the file already exists it will be cleared.
    Return value:
```
   0  OK.
   1  Unable to create file: incorrect file name, file is locked
      or file attribute is read-only.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    FileAppend(java.lang.String, java.lang.String)
  - FileAppend
```
protected int FileAppend(String fileName,
                         String data)
                  throws IllegalArgumentException
```
    Adds the line data to the end of the file with the name fileName. If the file does not exist it will be created.
    Return value:
```
   0  OK.
   1  Unable to add data to file: incorrect file name, file is locked
      or file attribute is read-only.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    FileCreate(java.lang.String)
  - Message
```
protected int Message(int type,
                      int icon,
                      String message)
```
    Requests and displays a message to the user. A message box will be displayed to the user containing the message. This function can also be used to ask the user simple questions. Type and Icon above refer to the desired message type and message icon, respectively (see below). The length of the message should not exceed 200 characters due to space limitations in a message box (Swing: JOptionPane).
    Note: At this time, only a REXX application (i.e. running in a separate thread can be used to retrieve the return value. This is due to the fact that the client can repond to the message at a later time. This limitation may be removed in the future.
    Type:
```
   1  Message with Cancel button.
   2  Message with OK button.
   3  Message with OK/Cancel question.
   4  Message with Enter button.
   5  Message with Enter/Cancel question.
   6  Message with Yes/No question.
   7  Message with Yes/No/Cancel question.
   8  Message with Retry/Cancel question.
   9  Message with Retry/Ignore/Cancel question.
 
```
    Icon:
```
   1  No icon
   2  Information code
   3  Question mark
   4  Warning code
   5  Stop code
 
```
    Return value:
```
   0  Incorrect parameters.
   1  Response: Cancel.
   2  Response: OK.
   3  Response: Enter.
   4  Response: Yes.
   5  Response: No.
   6  Response: Retry.
   7  Response: Ignore.
 
```
  - CallObject
```
protected String CallObject(String objectID,
                            String controlID,
                            int action,
                            String string)
                     throws IllegalArgumentException
```
    Calls a NetPhantom object.
    If a Java macro object is called from a REXX application, the REXX application will be stopped until the Java macro has completed. On the other hand, if an object that is of the Phantom Macro or REXX application type is called, the execution of the object is started asynchronously. This means that both objects run simultaneously in separate threads.
    The arguments to the object are not processed by NetPhantom and can be set to any strings. The limits of the length for the strings is 8 for ControlID and 250 for String.
    The actions are: CRT, REM, UCHG, HCHG, FOC, DEFOC, CLK, DBLCLK, CMD, SEL, CLOSE, CHAR, CHECK, HIDDEN, RECRT, XLATE, START, SHOW, QMSG.
    Parameters:
```
   objectID   Name of the object.
   controlID  A control ID passed to the object in argID.
   action     The object action passed in argMsg to the object.
   string     The string passed to the object as argStr.
 
```
    Return value:
```
   0      OK.
   1      General error.
   8      Error, action not found.
   9      Error, object not found.
   Other  Other returned strings depend on what the object returns.
 
```
    Throws:
    
    IllegalArgumentException
  - Wait
```
protected int Wait(int seconds)
```
    Waits for the number of seconds specified. Parameter is numbers of seconds to wait, 0 = 100 milliseconds.
  - LogonGet
```
protected int LogonGet()
```
    Reads the logon state of the currently initiated session. This logon state is never processed by NetPhantom but is only for the Java programs.
    
    See Also:
    
    LogonSet(int)
  - LogonSet
```
protected int LogonSet(int logonFlag)
                throws IllegalArgumentException
```
    Sets the logon state of the currently initiated session. This logon state is never processed by NetPhantom but is only for the Java programs.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    LogonGet()
  - GlobVarSet
```
protected int GlobVarSet(String varName,
                         String data)
                  throws IllegalArgumentException
```
    Sets a NetPhantom global variable.
    Return value:
```
   0  No error.
   1  Error, cannot set the variable.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    GlobVarGet(java.lang.String), GlobVarDelete(java.lang.String), SessVarSet(java.lang.String, java.lang.String)
  - GlobVarGet
```
protected String GlobVarGet(String varName)
                     throws IllegalArgumentException
```
    Gets a global variable. The global was created using the function GlobVarSet
    If the global variable cannot be retrieved, an empty string is returned.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    GlobVarSet(java.lang.String, java.lang.String), GlobVarDelete(java.lang.String), SessVarGet(java.lang.String)
  - GlobVarDelete
```
protected int GlobVarDelete(String varName)
                     throws IllegalArgumentException
```
    Deletes a NetPhantom global variable.
    Return value:
```
   0  No error.
   1  Error, cannot delete the variable.
   9  Variable not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    GlobVarGet(java.lang.String), GlobVarSet(java.lang.String, java.lang.String), SessVarDelete(java.lang.String)
  - SessVarSet
```
protected int SessVarSet(String varName,
                         String data)
                  throws IllegalArgumentException
```
    Sets a session variable. The variable is local to the current panel session. Session variables are not accessible with the @-sequence '@=var@' in text prompts.
    Return value:
```
   0  No error.
   1  Error, cannot set the variable.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    SessVarDelete(java.lang.String), SessVarGet(java.lang.String), GlobVarGet(java.lang.String), GlobVarSet(java.lang.String, java.lang.String), GlobVarDelete(java.lang.String), SessionStart(java.lang.String), SessionStop(java.lang.String), SessionSelect(java.lang.String)
  - SessVarGet
```
protected String SessVarGet(String varName)
                     throws IllegalArgumentException
```
    Gets a session variable. The variable is local to the current panel session. Session variables are not accessible with the @-sequence '@=var@' in text prompts. The global was created using the function SessVarSet
    If the session variable cannot be retrieved, an empty string is returned.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    SessVarDelete(java.lang.String), SessVarSet(java.lang.String, java.lang.String), GlobVarGet(java.lang.String), GlobVarSet(java.lang.String, java.lang.String), GlobVarDelete(java.lang.String), SessionStart(java.lang.String), SessionStop(java.lang.String), SessionSelect(java.lang.String)
  - SessVarDelete
```
protected int SessVarDelete(String varName)
                     throws IllegalArgumentException
```
    Deletes a session variable. The variable is local to the current panel session. Session variables are not accessible with the @-sequence '@=var@' in text prompts.
    Return value:
```
   0  No error.
   1  Error, cannot delete variable.
   9  Variable not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    SessVarGet(java.lang.String), SessVarSet(java.lang.String, java.lang.String), GlobVarGet(java.lang.String), GlobVarSet(java.lang.String, java.lang.String), GlobVarDelete(java.lang.String), SessionStart(java.lang.String), SessionStop(java.lang.String), SessionSelect(java.lang.String)
  - getHostFieldFromID
```
protected PhantomHostField getHostFieldFromID(String screenName,
                                              String fieldName)
```
    Internal method to get host field from current host screen or specified host screen or return null if not exist.
  - getHostScreenFromID
```
protected PhantomHostScreen getHostScreenFromID(String screenName)
```
    Internal method to get NetPhantom host screen from current host screen or specified host screen name or return null if not exist.
  - getVirtualComponentFromID
```
protected VirtualInterface getVirtualComponentFromID(String compID)
```
    Get control, menu item or special information. Returns VirtualInterface.
  - Time
```
protected String Time(String form)
```
    Return a formatted current time.
    
    Returns:
    
    time as a String.
    
    See Also:
    
    NetRexxMigration
  - Date
```
protected String Date(String form)
```
    Return a formatted current date.
    
    Returns:
    
    date as a String.
    
    See Also:
    
    NetRexxMigration
  - CharIn
```
protected String CharIn(String stream,
                        long position,
                        int length)
```
    CharIn returns a string of up to length characters read from the character input stream name. The default length is 1. For persistent streams, a read position is maintained for each stream. This is the same as the write position. Any read from the stream will by default start at the current read position. When the read is completed, the read position is increased by the number of characters read. A start value can be given to specify an explicit read position. This read position must be positive and within the bounds of the stream, and must not be specified for a transient stream (a port or other serial device). A value of 1 for start refers to the first character in the stream.
    If you specify a length of 0, then the read position will be set to the value of start, but no characters are read and the null string is returned. In a transient stream, if there are fewer then length characters available, then execution of the program will normally stop until sufficient characters do become available. If, however, it is impossible for those characters to become available due to an error or other problem, the NOTREADY condition is raised and CharIn will return with fewer than the requested number of characters.
    Here are some examples:
```
 CHARIN(myfile,1,3)   =   'MFC'     -- the first 3 characters
 CHARIN(myfile,1,0)   =   ''        -- now at start
 CHARIN(myfile)       =   'M'       -- after last call
 CHARIN(myfile,,2)    =   'FC'      -- after last call
 
```
    Note: CharIn returns all characters that appear in the stream including control characters such as line feed, carriage return, and end of file.
  - CharOut
```
protected long CharOut(String streamname,
                       String data,
                       long position)
```
    CharOut returns the count of characters remaining after attempting to write string to the character output stream name. The form of the name is implementation dependent. For persistent streams, a write position is maintained for each stream. This is the same as the read position. Any write to the stream starts at the current write position by default. When the write is completed the write position is increased by the number of characters written. The initial write position is the end of the stream, so that calls to CharOut normally append to the end of the stream.
    A start value can be given to specify an explicit write position for a persistent stream. This write position must be a positive whole number within the bounds of the stream (though it can specify the character position immediately after the end of the stream). A value of 1 for start refers to the first character in the stream.
    Note: In some environments, overwriting a stream with CharOut or LineOut can erase (destroy) all existing data in the stream.
  - Chars
```
protected long Chars(String streamname)
```
    Chars returns the total number of characters remaining in the character input stream name. The count includes any line separator characters, if these are defined for the stream, and in the case of persistent streams, is the count of characters from the current read position to the end of the stream.
    Here are some examples:
```
 CHARS(myfile)     =   42   -- perhaps
 CHARS(nonfile)    =   0    -- perhaps
 
```
  - FileSpec
```
protected String FileSpec(String opt,
                          String path)
```
    FileSpec returns a selected element of filespec, a given file specification, identified by one of the following strings for option:
```
 Drive   The drive letter of the given filespec.
 Path    The directory path of the given filespec.
 Name    The filename of the given filespec.
 
```
    If the requested string is not found, then FileSpec returns an empty string.
    Note: Only the initial letter of option is needed.
    Here are some examples:
```
 thisfile = "C:\UTIL\EXAMPLE.EXE"
 say FILESPEC("drive",thisfile)     -- says "C:"
 say FILESPEC("path",thisfile)      -- says "\UTIL\"
 say FILESPEC("name",thisfile)      -- says "EXAMPLE.EXE"
 
```
  - LineIn
```
protected String LineIn(String streamname,
                        long pos,
                        long count)
```
    LineIn returns count (0 or 1) lines read from the character input stream name. The form of the name is implementation dependent. The default count is 1. For persistent streams, a read position is maintained for each stream. This is the same as the write position. Any read from the stream starts at the current read position by default. A call to LineIn will return a partial line if the current read position is not at the start of a line. When the read is completed, the read position is moved to the beginning of the next line. The read position may be set to the beginning of the stream by giving line a value of 1.
    If a count of 0 is given, then no characters are read and the null string is returned. For transient streams, if a complete line is not available in the stream, then execution of the program will normally stop until the line is complete. If, however, it is impossible for a line to be completed due to an error or other problem, the NOTREADY condition is raised and LineIn returns whatever characters are available.
    Here are some examples:
```
 myfile = 'ANYFILE.TXT'
 LINEIN(myfile)     =  'Current line'    -- Reads one line from
 .                                       -- ANYFILE.TXT, beginning
 .                                       -- at the current read
 .                                       -- position. (If first call,
 .                                       -- file is opened and the
 .                                       -- first line is read.)
 .
 LINEIN(myfile,1,1) =  'first line'      -- Opens and reads the first
 .                                       -- line of ANYFILE.TXT (if
 .                                       -- the file is already open,
 .                                       -- reads first line); sets
 .                                       -- read position on the
 .                                       -- second line.
 .
 LINEIN(myfile,1,0) =   ''               -- No read; opens ANYFILE.TXT
 .                                       -- (if file is already open,
 .                                       -- sets the read position to
 .                                       -- the first line).
 .
 LINEIN(myfile,,0)  =   ''               -- No read; opens ANYFILE.TXT
 .                                       -- (no action if the file is
 .                                       -- already open).
 
```
  - LineOut
```
protected int LineOut(String streamname,
                      String data,
                      long line)
```
    LineOut returns the count of lines remaining after attempting to write string to the character output stream name. The count is either 0 (meaning the line was successfully written) or 1 (meaning that an error occurred while writing the line). string can be the empty string, in which case only the action associated with completing a line is taken. LineOut adds a operating system lineSeparator string ('\n' for Unix and '\r\n' for Windows). The form of the name is implementation dependent.
    For persistent streams, a write position is maintained for each stream. Any write to the stream starts at the current write position by default. Characters written by a call to LineOut can be added to a partial line. LineOut conceptually terminates a line at the end of each call. When the write is completed, the write position is set to the beginning of the line following the one just written. The initial write position is the end of the stream, so that calls to LineOut normally append lines to the end of the stream.
    You can set the write position to the first character of a persistent stream by giving a value of 1 (the only valid value) for line.
    Note: In some environments, overwriting a stream using CharOut or LineOut can erase (destroy) all existing data in the stream.
    Execution of the program normally stops until the output operation is effectively completed. If, however, it is impossible for a line to be written, the NOTREADY condition is raised and LineOut returns with a result of 1 (that is, the residual count of lines written).
    Here are some examples:
```
 myfile = 'ANYFILE.TXT'
 LINEOUT(myfile,'A new line')    -- Opens the file ANYFILE.TXT and
 .                               -- appends the string to the end.
 .                               -- If the file is already open,
 .                               -- the string is written at the
 .                               -- current write position.
 .                               -- Returns 0 if successful.
 .
 LINEOUT(myfile,'A new start',1) -- Opens the file (if not already
 .                               -- open); overwrites first line
 .                               -- with a new line.
 .                               -- Returns 0 if successful.
 .
 LINEOUT(myfile,,1)              -- Opens the file (if not already
 .                               -- open). No write; sets write
 .                               -- position at first character.
 .
 LINEOUT(myfile)                 -- Closes ANYFILE.TXT
 
```
  - Lines
```
protected int Lines(String streamname)
```
    Lines returns 1 if any data remains between the current read position and the end of the character input stream name, and returns 0 if no data remains. In effect, Lines reports whether a read action performed by CharIn or LineIn will succeed.
    The form of the name is implementation dependent.
    Here are some examples:
```
 LINES(myfile)    =     0    -- at end of the file
 .
 LINES("COM1:")   =     1    -- An OS/2 device name
 .                           -- always returns '1'
 
```
    Note: The Chars function returns the number of characters in a persistent stream or the presence of data in a transient stream.
  - Stream
```
protected String Stream(String streamname,
                        String operation,
                        String command)
```
    Stream returns a string describing the state of, or the result of an operation upon, the character stream name. This function is used to request information on the state of an input or output stream, or to carry out some specific operation on the stream.
    The first argument, name, specifies the stream to be accessed. The second argument can be one of the following strings (of which only the first letter is needed) which describes the action to be carried out:
    Command
    An operation (specified by the stream command given as the third argument) to be applied to the selected input or output stream. The string that is returned depends on the command performed, and can be the empty string.
    Description
    Also returns the current state of the specified stream. It is identical to the State operation, except that the returned string is followed by a colon and, if available, additional information about ERROR or NOTREADY states.
    State
    Returns a string that indicates the current state of the specified stream. This is the default operation. When used with the State option, Stream returns one of the following strings:
```
 'ERROR'    The stream has been subject to an erroneous operation (possibly during
 .          input, output, or through the Stream function. Additional information
 .          about the error may be available by invoking the Stream function with a
 .          request for the implementation-dependent description.
 .
 'NOTREADY' The stream is known to be in a state such that normal input or output
 .          operations attempted upon it would raise the NOTREADY condition. For
 .          example, a simple input stream may have a defined length; an attempt
 .          to read that stream (with the CharIn or LineIn functions, perhaps)
 .          beyond that limit may make the stream unavailable until the stream has
 .          been closed, for example, with LineIn(name), and then reopened.
 .
 'READY'    The stream is known to be in a state such that normal input or output
 .          operations can be attempted. This is the usual state for a stream,
 .          though it does not guarantee that any particular operation will succeed.
 .
 'UNKNOWN'  The state of the stream is unknown. This response can be used to indicate
 .          that the state of the stream cannot be determined.
 
```
    Stream Commands
    The following stream commands are used to:
    - Open a stream for reading or writing
    - Close a stream at the end of an operation
    - Position the read or write position within a persistent stream (for example, a file)
    - Get information about a stream (its existence, size, and last edit date).
    The stream command argument must be used when you select the operation C (command).
    The syntax is:
```
 STREAM(name,'C',streamCommand)
 
```
    In this form, the Stream function itself returns a string corresponding to the given stream command if the command is successful. If the command is unsuccessful, Stream returns an error message string in the same form as that supplied by the D (Description) operation.
    Command strings
    The argument stream command can be any expression that evaluates as one of the following command strings:
```
 'OPEN'         Opens the named stream. The default for 'OPEN' is to open the stream
 .              for both reading and writing data. To specify whether name is only to
 .              be read or only to be written to, add the word READ or WRITE to the
 .              command string.
 .
 .              The Stream function itself returns 'READY' if the named stream is
 .              successfully opened or an appropriate error message if unsuccessful.
 .
 .                  stream(strout,'c','open')
 .                  stream(strout,'c','open write')
 .                  stream(strinp,'c','open read')
 .
 'CLOSE'        Closes the named stream. The STREAM function itself returns 'READY'
 .              if the named stream is successfully closed or an appropriate error
 .              message otherwise.
 .
 .              If an attempt is made to close an unopened file, then Stream returns
 .              an empty string.
 .
 .                  stream('STRM.TXT','c','close')
 .
 'SEEK' offset  Sets the read or write position a given number (offset) within a
 .              persistent stream. Note: In environments in which the read and write
 .              positions are the same. To use this command, the named stream must
 .              first be opened (with the 'OPEN' stream command, described previously).
 .              The offset number can be preceded by one of the following characters:
 .
 .                  =     Explicitly specifies the offset from the beginning
 .                        of the stream. This is the default if no prefix is supplied.
 .
 .                  <     Specifies offset from the end of the stream.
 .
 .                  +     Specifies offset forward from the current read or write position.
 .
 .                  -     Specifies offset backward from the current read or write position.
 
```
    The Stream function itself returns the new position in the stream if the read or write position is successfully located; an appropriate error message is displayed otherwise.
```
 .   rc = stream(name,'c','seek =2')
 .   rc = stream(name,'c','seek +15')
 .   rc = stream(name,'c','seek -7')
 .   fromend = 125
 .   rc = stream(name,'c','seek <'fromend)
 
```
    Used with these stream commands, the Stream function returns specific information about a stream.
```
 'QUERY EXISTS'    Returns the full path specification of the named stream, if it
 .                 exists, and a null string otherwise.
 .
 .                    stream('file.txt','c','query exists')
 .
 'QUERY SIZE'      Returns the size in bytes of a persistent stream.
 .
 .                    stream('file.txt','c','query size')
 .
 'QUERY DATETIME'  Returns the date and time stamps of a stream.
 .
 .                    stream('file.txt','c','query datetime')
 .
 .                 The stream (file) last modified date in UTC formatted as RFC 1123,
 .                 i.e. in Java date format  EEE, dd MMM yyyy HH:mm:ss 'GMT',
 .                 e.g.  Sun, 21 Feb 2022 12:16:24 GMT.
 
```
  - Report
```
protected String Report(String com,
                        String p1,
                        String p2,
                        String p3,
                        String p4,
                        String p5)
```
    Handles the printing of a report.
    
    Parameters:
    
    com - The report command to execute.
  - SendEmail
```
protected String SendEmail(String com,
                           String p1)
```
    Handles the mail functionality.
    
    Parameters:
    
    com - The mail command to execute.
  - SendSMS
```
protected String SendSMS(String command,
                         String param1,
                         String param2)
```
    Handles the sms functionality.
    
    Parameters:
    
    command - The sms command to execute.
    
    param1 - The phone number or a comma-separated list of phone numbers.
    
    param2 - The message
    
    Returns:
    
    int 0 for ok, 1 for no installed SMS utility, 2 for error and 9 for unknown command.
  - ShowDocument
```
protected int ShowDocument(String url,
                           String target)
```
    Show HTML document from applet.
    
    Parameters:
    
    url - The URL of the document.
    
    target - The HTML window target, _blank is default.
  - ClientExecute
```
protected String ClientExecute(boolean async,
                               String command,
                               String data)
```
    Performs a task on the client side. The first parameter should be true (=sync) or false (=async) execution mode, the second parameter the command to execute (if the data parameter is null), otherwise the command parameter is the file name for the temporary file that is created with the "data".
  - ExecuteProcess
```
protected String ExecuteProcess(String dir,
                                boolean useRuntimeDir,
                                String cmdLine)
```
    Executes a Process, waiting for the response code and reading the STDOUT/STDERR output streams. The process will execute in the directory specified (only works with JDK 1.3 or better). The environment variables will be set from the currently set NetPhantom Global Variables. The "cmdLine" parameter will be parsed (as under Windows) with quotes when executing the process under Unix operating systems.
    A return code less than zero indicates an error.
    
    Returns:
    
    Empty string for failure when a directory is specified and/or the JDK is not 1.3 or better, otherwise a return string indicating the return code concatenated with '\x01', STDOUT stream as a string, '\x01', STDERR stream as string.
  - CreateTempFile
```
protected String CreateTempFile()
```
    Creates a temporary file in the directory of the current runtime file and adds it for removal when the client session is disposed of.
    
    Returns:
    
    empty string if the client session is disposed of or the file couldn't be created, otherwise a temporary file name.
  - RemoveTempFile
```
protected int RemoveTempFile(String fileName)
```
    Removes a temporary file name from the client session. If the file exists, it is deleted.
    
    Returns:
    
    0 for success, 1 if the file name was not registered using the "getTempFileName" call.
  - DeleteFile
```
protected int DeleteFile(String fileName)
```
    Deletes a file.
    
    Returns:
    
    0 for success, 1 for failure.
  - PanSetCtlProperty
```
protected int PanSetCtlProperty(String controlID,
                                String property,
                                String data)
                         throws IllegalArgumentException
```
    Sets a property of a panel control. The property data should be either a value "0" or "1" that is converted to a Boolean, a Boolean string "true" or "false", an Long value or a String. The property being set is first tested a Boolean, then Long followed by a String.
    If ControlID is *PANEL the text for the current panel is set. If it is *APP the text for the application panel is set.
    Return value:
```
   0  OK.
   1  Error.
   9  Error, control not found.
 
```
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanGetCtlProperty(java.lang.String, java.lang.String)
  - PanGetCtlProperty
```
protected String PanGetCtlProperty(String controlID,
                                   String property)
                            throws IllegalArgumentException
```
    Retrieves a property of a panel control. The property is defined by the control type and return an object that supports the "toString()" method that will be returned by this function. The return value is an empty string when the control is not found or the property is not found.
    If ControlID is *PANEL, the text for the current panel is retrieved. If it is *APP the text for the application panel is retrieved.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    PanSetCtlProperty(java.lang.String, java.lang.String, java.lang.String)
  - PanSetRatioAndFontScaling
```
protected boolean PanSetRatioAndFontScaling(int ratioX,
                                            int ratioY,
                                            boolean doScaleFonts)
```
    Sets the ratioX and ratioY parameters and if the fonts should be scaled with these ratio parameters also.
    Note: when these settings are changed, it is important to quickly display a MAIN panel that has the option "Change main panel size" in order to recalculate the size and fonts correctly.
    
    Parameters:
    
    ratioX - the ratio in X for scaling in percent (%), 100=normal.
    
    ratioY - the ratio in Y for scaling in percent (%), 100=normal.
    
    doScaleFonts - flag indicating if the fonts should be scaled as well.
    
    Returns:
    
    true for success, false for failure (e.g. not a Java Client or the Editor).
  - PanEnableClientProcessing
```
protected boolean PanEnableClientProcessing(boolean on)
```
    Enabled or disables all client processing.
    
    Parameters:
    
    on - true to enable processing, false to disable it.
    
    Returns:
    
    true for a setting change, false if nothing was changed.
  - PanIsClientProcessingEnabled
```
protected boolean PanIsClientProcessingEnabled()
```
    Checks if client processing is enabled.
    
    Returns:
    
    true if client processing is enabled, false otherwise.
  - StartLog
```
protected boolean StartLog()
```
    Set direct logging active.
    
    Returns:
    
    true if direct logging can be set active.
  - StopLog
```
protected boolean StopLog()
```
    Set direct logging inactive.
    
    Returns:
    
    true if direct logging can be set inactive.
  - RotateLog
```
protected boolean RotateLog()
```
    Rotate the log file (if configured to rotate on log file size).
    
    Returns:
    
    true if direct logging can be set inactive.
  - LogMsg
```
protected boolean LogMsg(String msg)
```
    Send log entry to direct logger.
    
    Returns:
    
    true if message can be logged.
  - getCodepageConverter
```
public CodepageConverter getCodepageConverter()
```
    Gets the CodepageConverter that is appropriate for writing files with this runtime. For NetPhantom 6 is is ANSI-type, and for NP5(-) it's OEM.

Class REXXMigration

Typical REXX program

Typical REXX program ported to Java

External REXX functions

Unsupported REXX functions

Control IDs

Field Summary

Fields inherited from interface se.entra.phantom.server.ObjectCalling

Fields inherited from interface se.entra.phantom.server.ObjectMessages

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_TIMEOUT

CTLSTYLE_DISABLE

CTLSTYLE_ENABLE

CTLSTYLE_HIDE

CTLSTYLE_SHOW

CTLSTYLE_READONLY

REXX_ERR_GENERAL

REXX_ERR_TIMEOUT

REXX_ERR_NOSTATE

REXX_ERR_FILENOTFOUND

REXX_ERR_READERROR

REXX_ERR_HOSTFLDNOTFOUND

REXX_ERR_NOTFOUND

Constructor Detail

REXXMigration

Method Detail

setWorker

getWorker

setVirtualInterface

getVirtualInterface

setReturnString

getReturnString

start

HostConnect

HostDisconnect

HostGetSession

HostError

HostSetTimeout

HostGetTimeout

HostGetRow

HostGetCol

HostSetCursor

HostWait

HostWaitScreen

HostSend

HostSendDirect

HostSendFilePsw

HostGetLine

HostGetString

HostSetFld

HostGetFld

HostGetFldClr

HostGetScreen

HostGetLastErr

HostGetFldAttr

HostGetFldLen

HostGetCurrFld

HostSetCursorToFld

HostHideSession

MacroPlay

ScrComp

ScrWait

ScrMultiWait

ScrMultiWait2

ScrMatch

ScrGetNext

PanCreate

PanPreload

PanProcess

PanEnd

PanDestroy

PanRemove

PanHostInhibit

PanLock

PanSetCtlData

PanGetCtlData