public class NetRexxMigration extends Object implements ObjectCalling, ObjectMessages
The purpose of this class is to make the Phantom API available to REXX programs as similar as possible for NetRexx programs that are ported from REXX. Using this class as a base class will allow only a minimal change of the code.
Also see the REXXMigration class.
rc=my_external_function('param1',10)
should be done in NetRexx like:
my_external_function m_e_f // Only needed once.
m_e_f.setWorker(getWorker()) // Only needed once.
rc = m_e_f.aNewFunction('param1', 10)
and the "my_external_function" class:
import se.entra.phantom.server.NetRexxMigration
class INITKF58 extends NetRexxMigration
method start(argId, argMsg, argStr) returns Rexx
-- ...code...
CHAR, CHECK, CLK, CLOSE, CMD, CRT, DBLCLK, DEFOC, FOC, HCHG, HIDDEN, QMSG, RECRT, REM, SEL, SHOW, START, UCHG, XLATEOBJACT_CHAR, OBJACT_CHECK, OBJACT_CLICK, OBJACT_CLOSE, OBJACT_COMMAND, OBJACT_CREATE, OBJACT_DBLCLICK, OBJACT_DDECONNECTION, OBJACT_DDEDATA, OBJACT_DDEERROR, OBJACT_DDEEXECUTE, OBJACT_DDEPOKE, OBJACT_DDEREQUEST, OBJACT_DDEVALIDATE, OBJACT_DEFOCUS, OBJACT_DESTROY, OBJACT_FOCUS, OBJACT_HIDDEN, OBJACT_HOSTCHANGE, OBJACT_LAST_MESSAGE_HANDLED, OBJACT_QUERYMSG, OBJACT_RECREATE, OBJACT_SELECT, OBJACT_SHOW, OBJACT_START, OBJACT_TRANSLATE, OBJACT_USERCHANGE, PHA_ICO_INFO, PHA_ICO_NOICON, PHA_ICO_QUESTION, PHA_ICO_STOP, PHA_ICO_WARNING, PHA_MSG_CANCEL, PHA_MSG_ENTER, PHA_MSG_ENTERCANCEL, PHA_MSG_OK, PHA_MSG_OKCANCEL, PHA_MSG_RETIGNCANCEL, PHA_MSG_RETRYCANCEL, PHA_MSG_YESNO, PHA_MSG_YESNOCANCEL| Constructor and Description |
|---|
NetRexxMigration()
No need for a constructor in the derived class.
|
| Modifier and Type | Method and Description |
|---|---|
protected netrexx.lang.Rexx |
Beep(netrexx.lang.Rexx frequency,
netrexx.lang.Rexx duration)
This method should normally cause a beep and is supported in REXX.
|
protected netrexx.lang.Rexx |
Bitand(netrexx.lang.Rexx first,
netrexx.lang.Rexx second,
netrexx.lang.Rexx pad)
Converted REXX function for compatibility reason.
|
protected netrexx.lang.Rexx |
Bitor(netrexx.lang.Rexx first,
netrexx.lang.Rexx second,
netrexx.lang.Rexx pad)
Converted REXX function for compatibility reason.
|
protected netrexx.lang.Rexx |
Bitxor(netrexx.lang.Rexx first,
netrexx.lang.Rexx second,
netrexx.lang.Rexx pad)
Converted REXX function for compatibility reason.
|
protected netrexx.lang.Rexx |
CallObject(netrexx.lang.Rexx objectID,
netrexx.lang.Rexx controlID,
netrexx.lang.Rexx action,
netrexx.lang.Rexx string)
Calls a Phantom object.
|
netrexx.lang.Rexx |
CharIn(netrexx.lang.Rexx name,
netrexx.lang.Rexx position,
netrexx.lang.Rexx length)
CharIn returns a string of up to length characters read from the
character input stream name.
|
netrexx.lang.Rexx |
CharOut(netrexx.lang.Rexx name,
netrexx.lang.Rexx chars,
netrexx.lang.Rexx position)
CharOut returns the count of characters remaining after attempting to write
string to the character output stream name.
|
protected netrexx.lang.Rexx |
Chars(netrexx.lang.Rexx name)
Chars returns the total number of characters remaining in the character input
stream name.
|
protected netrexx.lang.Rexx |
ClientExecute(netrexx.lang.Rexx async,
netrexx.lang.Rexx command,
netrexx.lang.Rexx data)
Performs a task on the client side.
|
protected netrexx.lang.Rexx |
ClipbrdGet()
This method get the clipboard data from the client.
|
protected netrexx.lang.Rexx |
ClipbrdSet(netrexx.lang.Rexx data)
This method set the clipboard on the client.
|
protected netrexx.lang.Rexx |
CompLine(netrexx.lang.Rexx line,
netrexx.lang.Rexx string)
This method compares a text string containing wildcards with a line on the
host screen.
|
protected netrexx.lang.Rexx |
CompPos(netrexx.lang.Rexx line,
netrexx.lang.Rexx column,
netrexx.lang.Rexx string)
This method compares a text string without wildcards with a certain position
(line and column) on the host screen.
|
protected netrexx.lang.Rexx |
CompScreen(netrexx.lang.Rexx string)
This method compares a text string containing wildcards with the entire host
screen.
|
protected netrexx.lang.Rexx |
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 netrexx.lang.Rexx |
Datatype(netrexx.lang.Rexx variable)
When attempting to perform arithmetic on data entered from the keyboard,
you can use the DATATYPE() function to check that the data is valid.
|
protected netrexx.lang.Rexx |
Date(netrexx.lang.Rexx form)
Date returns, by default, the local date in the format: dd mon yyyy
(for example, 27 Aug 1988), with no leading zero or blank on the day.
|
protected netrexx.lang.Rexx |
DdeExecute(netrexx.lang.Rexx dde_nn,
netrexx.lang.Rexx command)
This function sends the DDE verb EXECUTE to the application and the
subject that is initiated to dde_nn.
|
protected netrexx.lang.Rexx |
DdeInitiate(netrexx.lang.Rexx programName,
netrexx.lang.Rexx subject)
This function requests communication with the program ProgramName with the
subject Subject.
|
protected netrexx.lang.Rexx |
DdePoke(netrexx.lang.Rexx dde_nn,
netrexx.lang.Rexx location,
netrexx.lang.Rexx data)
This function sends the DDE verb POKE to the application and subject
which is initiated to dde_nn.
|
protected netrexx.lang.Rexx |
DdeTerminate(netrexx.lang.Rexx dde_nn)
This function exits communication with the DDE session dde_nn.
|
protected netrexx.lang.Rexx |
DeleteFile(netrexx.lang.Rexx fileName)
Deletes a file.
|
protected netrexx.lang.Rexx |
ExecuteProcess(netrexx.lang.Rexx dir,
netrexx.lang.Rexx useRuntimeDir,
netrexx.lang.Rexx cmdLine)
Executes a Process, waiting for the response code and
reading the STDOUT/STDERR output streams.
|
protected netrexx.lang.Rexx |
FileAppend(netrexx.lang.Rexx fileName,
netrexx.lang.Rexx data)
Adds the line data to the end of the file with the name fileName.
|
protected netrexx.lang.Rexx |
FileCreate(netrexx.lang.Rexx fileName)
Creates an empty file with the name fileName.
|
netrexx.lang.Rexx |
FileSpec(netrexx.lang.Rexx part,
netrexx.lang.Rexx name)
FileSpec returns a selected element of filespec, a given file specification,
identified by one of the following strings for option:
|
String |
getReturnString()
Gets the return string for the object.
|
VirtualInterface |
getVirtualInterface()
Internal function to get the virtual interface to the calling object.
|
PhantomWorker |
getWorker()
Internal function to get the interface to the PhantomWorker class.
|
protected netrexx.lang.Rexx |
GlobVarDelete(netrexx.lang.Rexx varName)
Deletes a Phantom global variable.
|
protected netrexx.lang.Rexx |
GlobVarGet(netrexx.lang.Rexx varName)
Gets a global variable.
|
protected netrexx.lang.Rexx |
GlobVarSet(netrexx.lang.Rexx varName,
netrexx.lang.Rexx data)
Sets a Phantom global variable.
|
protected netrexx.lang.Rexx |
HostConnect(netrexx.lang.Rexx sessionID)
Starts communication with a host session.
|
protected netrexx.lang.Rexx |
HostDisconnect()
Disconnects communication with current host session.
|
protected netrexx.lang.Rexx |
HostError()
Checks for errors in in contact with the host session.
|
protected netrexx.lang.Rexx |
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 netrexx.lang.Rexx |
HostGetCurrFld()
Gets the current host field of the current screen (to get the current screen use HostGetScreen).
|
protected netrexx.lang.Rexx |
HostGetFld(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
Retrieves the contents of a host field.
|
protected netrexx.lang.Rexx |
HostGetFldAttr(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
Retrieves the attribute of a host field.
|
protected netrexx.lang.Rexx |
HostGetFldClr(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
Retrieves the color of a host field.
|
protected netrexx.lang.Rexx |
HostGetFldLen(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
Returns the length of the host field FieldName or 0 if not found.
|
protected netrexx.lang.Rexx |
HostGetLastErr(netrexx.lang.Rexx clear)
Retrieves the last host error message for 5250.
|
protected netrexx.lang.Rexx |
HostGetLine(netrexx.lang.Rexx lineNo)
Returns a line from the host screen.
|
protected netrexx.lang.Rexx |
HostGetRow()
Returns the current row of the cursor in the session.
|
protected netrexx.lang.Rexx |
HostGetScreen()
Returns the current matching screen or empty string if none.
|
protected netrexx.lang.Rexx |
HostGetSession()
Returns the current host session's ID (A-Z)
|
protected netrexx.lang.Rexx |
HostGetString(netrexx.lang.Rexx line,
netrexx.lang.Rexx column,
netrexx.lang.Rexx length)
Returns a string from the host screen.
|
protected netrexx.lang.Rexx |
HostGetTimeout()
Returns the current time-out value in seconds (0-998 seconds, 999=no time-out).
|
protected netrexx.lang.Rexx |
HostHideSession(netrexx.lang.Rexx hideFlag)
This method hides or shows the terminal emulator window.
|
protected netrexx.lang.Rexx |
HostSend(netrexx.lang.Rexx string,
netrexx.lang.Rexx startTimer,
netrexx.lang.Rexx stopTimer,
netrexx.lang.Rexx newMsg)
Sends a series of keystrokes to the host and waits for the lock state to disapear.
|
protected netrexx.lang.Rexx |
HostSendDirect(netrexx.lang.Rexx string,
netrexx.lang.Rexx newMsg)
Sends a series of keystrokes to the host.
|
protected netrexx.lang.Rexx |
HostSendFilePsw(netrexx.lang.Rexx userID)
Sends a password to the host which is then stored on disk in encrypted form.
|
protected netrexx.lang.Rexx |
HostSetCursor(netrexx.lang.Rexx line,
netrexx.lang.Rexx column)
Sets the cursor position.
|
protected netrexx.lang.Rexx |
HostSetCursorToFld(netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineOffset)
Sets the cursor position to the beginning of a host field with a line offset.
|
protected netrexx.lang.Rexx |
HostSetFld(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx data,
netrexx.lang.Rexx lineNo)
Sets a host field with text.
|
protected netrexx.lang.Rexx |
HostSetTimeout(netrexx.lang.Rexx timeoutValue)
Sets the time-out value used in waiting and comparison functions.
|
protected netrexx.lang.Rexx |
HostWait(netrexx.lang.Rexx numWait)
Waits for the "wait" state of the session to disappear.
|
protected netrexx.lang.Rexx |
HostWaitScreen()
Waits for any screen change, e.g.
|
netrexx.lang.Rexx |
LineIn(netrexx.lang.Rexx name,
netrexx.lang.Rexx position,
netrexx.lang.Rexx length)
LineIn returns count (0 or 1) lines read from the character input stream name.
|
netrexx.lang.Rexx |
LineOut(netrexx.lang.Rexx name,
netrexx.lang.Rexx data,
netrexx.lang.Rexx line)
LineOut returns the count of lines remaining after attempting to
write string to the character output stream name.
|
netrexx.lang.Rexx |
Lines(netrexx.lang.Rexx name)
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 netrexx.lang.Rexx |
LogMsg(String msg)
Send log entry to direct logger.
|
protected netrexx.lang.Rexx |
LogonGet()
Reads the logon state of the currently initiated session.
|
protected netrexx.lang.Rexx |
LogonSet(netrexx.lang.Rexx logonFlag)
Sets the logon state of the currently initiated session.
|
protected netrexx.lang.Rexx |
MacroPlay(netrexx.lang.Rexx macroName,
netrexx.lang.Rexx[] arguments)
This function plays back a macro.
|
protected netrexx.lang.Rexx |
Message(netrexx.lang.Rexx type,
netrexx.lang.Rexx icon,
netrexx.lang.Rexx message)
Requests and displays a message to the user.
|
protected netrexx.lang.Rexx |
PanCallCtl(netrexx.lang.Rexx controlID)
Activates a menu item or a push button with control ID
controlID. |
protected netrexx.lang.Rexx |
PanChart(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx function,
netrexx.lang.Rexx data)
Function for processing graphical charts.
|
protected netrexx.lang.Rexx |
PanCheckGet(netrexx.lang.Rexx controlID)
Retrieves the selection of a radio button or check box.
|
protected netrexx.lang.Rexx |
PanCheckSet(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx checkState)
Sets the selection of a radio button or check box.
|
protected netrexx.lang.Rexx |
PanComboFromFile(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx fileName)
Fills a combination box with contents of a text file.
|
protected netrexx.lang.Rexx |
PanCreate(netrexx.lang.Rexx panelID)
Creates a new panel.
|
protected netrexx.lang.Rexx |
PanDestroy()
Removes or destroys the topmost panel.
|
protected netrexx.lang.Rexx |
PanelExit()
Exits the current client session.
|
protected netrexx.lang.Rexx |
PanEnableClientProcessing(netrexx.lang.Rexx on)
Enabled or disables all client processing.
|
protected netrexx.lang.Rexx |
PanEnd(netrexx.lang.Rexx string)
Exits a PanProcess function issued from another thread with string.
|
protected netrexx.lang.Rexx |
PanFormatText(netrexx.lang.Rexx text)
Parses string to resolve @-sequences.
|
protected netrexx.lang.Rexx |
PanGetCtlData(netrexx.lang.Rexx controlID)
Retrieves the contents of a panel control.
|
protected netrexx.lang.Rexx |
PanGetCtlLen(netrexx.lang.Rexx controlID)
Get the length of a panel control.
|
protected netrexx.lang.Rexx |
PanGetCtlProperty(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx property)
Retrieves the contents of a panel control.
|
protected netrexx.lang.Rexx |
PanGetCtlStyle(netrexx.lang.Rexx controlID)
Retrieves a control style.
|
protected netrexx.lang.Rexx |
PanGetCurrNbPage(netrexx.lang.Rexx controlID)
Get the current notebook page.
|
protected netrexx.lang.Rexx |
PanGetCurrPanel()
Retrieves the name of the current panel.
|
protected netrexx.lang.Rexx |
PanGetDllExt(netrexx.lang.Rexx name)
Get a system dependent extension of a file name.
|
protected netrexx.lang.Rexx |
PanGetFocus()
Get the current panel/control that has focus or empty string
if focus not could be found.
|
protected netrexx.lang.Rexx |
PanGetText(netrexx.lang.Rexx textID)
Retrieves a text from the current text file.
|
protected netrexx.lang.Rexx |
PanHostInhibit(netrexx.lang.Rexx inhibitState)
Removes or restores panel processing between Phantom and the terminal session.
|
protected netrexx.lang.Rexx |
PanIsClientProcessingEnabled()
Checks if client processing is enabled.
|
protected netrexx.lang.Rexx |
PanListClear(netrexx.lang.Rexx controlID)
Clears a list of all its contents.
|
protected netrexx.lang.Rexx |
PanListDelete(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx line)
Deletes a line (1-nn) from a list.
|
protected netrexx.lang.Rexx |
PanListFromFile(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx fileName)
Fills a list with data from a text file.
|
protected netrexx.lang.Rexx |
PanListGetData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo)
Retrieves the contents of a line (1-nn) in a list.
|
protected netrexx.lang.Rexx |
PanListGetFld(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo,
netrexx.lang.Rexx columnNo)
Function to retrieve a list field (a line [1-nn] and a column [1-columnCount]).
|
protected netrexx.lang.Rexx |
PanListGetNum(netrexx.lang.Rexx controlID)
Get number of lines in a list.
|
protected netrexx.lang.Rexx |
PanListGetSel(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx prevLine)
Retrieves the next selected line in a list or zero if no more selections exists.
|
protected netrexx.lang.Rexx |
PanListInsertData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx line,
netrexx.lang.Rexx data)
Adds or inserts a line of Data in a list.
|
protected netrexx.lang.Rexx |
PanListSetData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo,
netrexx.lang.Rexx data)
Update a line in a list.
|
protected netrexx.lang.Rexx |
PanListSetFld(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo,
netrexx.lang.Rexx columnNo,
netrexx.lang.Rexx data)
Function to set a list field (a line [1-nn] and a column [1-columnCount]).
|
protected netrexx.lang.Rexx |
PanListSetSel(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx line,
netrexx.lang.Rexx selectionState)
Selects or deselects a line in a list.
|
protected netrexx.lang.Rexx |
PanListToFile(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx fileName)
Stores the contents of a list into a text file.
|
protected netrexx.lang.Rexx |
PanLock(netrexx.lang.Rexx lockState)
Locks or restores user panel processing.
|
protected netrexx.lang.Rexx |
PanNbCancelPaging()
Cancels notebook paging when a user has selected a notebook page that is not the Next or the Previous one.
|
protected netrexx.lang.Rexx |
PanPreload(netrexx.lang.Rexx panelID)
Preloads a panel the same way as when next panel is connected to a push button or a menu item.
|
protected netrexx.lang.Rexx |
PanProcess()
Starts processing a panel.
|
protected netrexx.lang.Rexx |
PanRemove()
Removes or destroys the topmost panel.
|
protected netrexx.lang.Rexx |
PanSelectCurrCtl()
This function selects the current entry field.
|
protected netrexx.lang.Rexx |
PanSetCtlClr(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx foreground,
netrexx.lang.Rexx background)
This function set or removes the colors of a control.
|
protected netrexx.lang.Rexx |
PanSetCtlData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx data)
Sets the contents of a panel control.
|
protected netrexx.lang.Rexx |
PanSetCtlLen(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx length)
Set the length of a panel control.
|
protected netrexx.lang.Rexx |
PanSetCtlProperty(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx property,
netrexx.lang.Rexx data)
Sets the contents of a panel control.
|
protected netrexx.lang.Rexx |
PanSetCtlStyle(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx style)
Sets style of panel control.
|
protected netrexx.lang.Rexx |
PanSetCurFromHost()
Places the cursor in the panel in the same position it has in the terminal session.
|
protected netrexx.lang.Rexx |
PanSetFocus(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx selectControl)
Sets focus to a panel control.
|
protected netrexx.lang.Rexx |
PanSetPanelFromHost(netrexx.lang.Rexx[] panels)
Sets the correct panel from the current cursor position.
|
protected netrexx.lang.Rexx |
PanSetRatioAndFontScaling(netrexx.lang.Rexx ratioX,
netrexx.lang.Rexx ratioY,
netrexx.lang.Rexx doScaleFonts)
Sets the ratioX and ratioY parameters and if the fonts should
be scaled with these ratio parameters also.
|
protected netrexx.lang.Rexx |
PanSetTextFile(netrexx.lang.Rexx fileName)
Swaps the current text file for the specified file name.
|
protected netrexx.lang.Rexx |
PanSetXlateFile(netrexx.lang.Rexx fileName)
Swaps the current translation file for the specified file name.
|
protected netrexx.lang.Rexx |
PanUpdate()
Updates all controls and menus in the panel in respect to text and translation files and the current host screen.
|
protected netrexx.lang.Rexx |
PanXlate(netrexx.lang.Rexx text)
Translates the string using the current translation table.
|
netrexx.lang.Rexx |
Random(netrexx.lang.Rexx max)
RANDOM returns a quasi-random, nonnegative whole number in the range
min to max inclusive.
|
protected netrexx.lang.Rexx |
RemoveTempFile(netrexx.lang.Rexx fileName)
Removes a temporary file name from the client session.
|
protected netrexx.lang.Rexx |
Report(netrexx.lang.Rexx com,
netrexx.lang.Rexx p1,
netrexx.lang.Rexx p2,
netrexx.lang.Rexx p3,
netrexx.lang.Rexx p4,
netrexx.lang.Rexx p5)
Report printer commands.
|
protected netrexx.lang.Rexx |
RotateLog()
Rotate the log file (if configured to rotate on log file size).
|
protected netrexx.lang.Rexx |
ScrComp(netrexx.lang.Rexx screenName)
Compares the host screen with screen name without waiting.
|
protected netrexx.lang.Rexx |
ScrGetNext()
Retrieves the name of the next matching screen identity after ScrMatch.
|
protected netrexx.lang.Rexx |
ScrMatch()
Matches the screen with all the screen identities.
|
protected netrexx.lang.Rexx |
ScrMultiWait(netrexx.lang.Rexx[] screenNames)
Waits until the screen matches one of the specified screen identities.
|
protected netrexx.lang.Rexx |
ScrWait(netrexx.lang.Rexx screenName)
Waits until the screen matches the screen identity.
|
protected netrexx.lang.Rexx |
SendEmail(netrexx.lang.Rexx com,
netrexx.lang.Rexx p1)
Send mail commands.
|
protected netrexx.lang.Rexx |
SendSMS(netrexx.lang.Rexx com,
netrexx.lang.Rexx p1,
netrexx.lang.Rexx p2)
Send SMS commands.
|
protected netrexx.lang.Rexx |
SessionExit()
Exits the current client session.
|
protected netrexx.lang.Rexx |
SessionGet()
Retrieves the session that is in the foreground.
|
protected netrexx.lang.Rexx |
SessionGetAll()
Retrieves all the sessions that have been started.
|
protected netrexx.lang.Rexx |
SessionSelect(netrexx.lang.Rexx sessionID)
Places the session in the foreground of all panel sessions.
|
protected netrexx.lang.Rexx |
SessionStart(netrexx.lang.Rexx sessionID)
Starts a new main panel session for an application panel.
|
protected netrexx.lang.Rexx |
SessionStop(netrexx.lang.Rexx sessionID)
Stops a panel session.
|
protected netrexx.lang.Rexx |
SessVarDelete(netrexx.lang.Rexx varName)
Deletes a session variable.
|
protected netrexx.lang.Rexx |
SessVarGet(netrexx.lang.Rexx varName)
Gets a session variable.
|
protected netrexx.lang.Rexx |
SessVarSet(netrexx.lang.Rexx varName,
netrexx.lang.Rexx data)
Sets a session variable.
|
void |
setReturnString(netrexx.lang.Rexx s)
Sets the return string for the object.
|
void |
setReturnString(String s)
Sets the return string for the object.
|
void |
setVirtualInterface(VirtualInterface vI)
Internal function to set the virtual interface to the calling object.
|
void |
setWorker(PhantomWorker p)
Internal function to setup the interface to the PhantomWorker class.
|
protected netrexx.lang.Rexx |
ShowDocument(netrexx.lang.Rexx url,
netrexx.lang.Rexx target)
Show HTML document from Applet.
|
netrexx.lang.Rexx |
start(netrexx.lang.Rexx argId,
netrexx.lang.Rexx argMsg,
netrexx.lang.Rexx argStr)
This is the function that starts the Java object.
|
void |
start(String argId,
int argMsg,
String argStr)
This is the function that starts the Java object.
|
protected netrexx.lang.Rexx |
StartLog()
Set direct logging active.
|
protected netrexx.lang.Rexx |
StopLog()
Set direct logging inactive.
|
netrexx.lang.Rexx |
Stream(netrexx.lang.Rexx name,
netrexx.lang.Rexx operation,
netrexx.lang.Rexx command)
Stream returns a string describing the state of, or the result of an operation
upon, the character stream name.
|
protected netrexx.lang.Rexx |
Time(netrexx.lang.Rexx form)
Time returns the local time in the 24-hour clock format hh:mm:ss (hours, minutes, and seconds)
by default; for example:
04:41:37. |
protected netrexx.lang.Rexx |
TimerGet(netrexx.lang.Rexx timerNo)
Returns the current reading on a timer (1-9) in hundredth of seconds.
|
protected netrexx.lang.Rexx |
TimerPause(netrexx.lang.Rexx timerNo)
Pauses a timer (1-9).
|
protected netrexx.lang.Rexx |
TimerStart(netrexx.lang.Rexx timerNo)
Starts a timer (1-9).
|
protected netrexx.lang.Rexx |
TimerStop(netrexx.lang.Rexx timerNo)
Stops a timer (1-9).
|
protected netrexx.lang.Rexx |
translate(netrexx.lang.Rexx string,
netrexx.lang.Rexx tableo,
netrexx.lang.Rexx tablei,
netrexx.lang.Rexx pad)
Implementation of the REXX TRANSLATE function for NetRexx.
|
protected netrexx.lang.Rexx |
Wait(netrexx.lang.Rexx seconds)
Waits for the number of seconds specified.
|
protected netrexx.lang.Rexx |
WCompLine(netrexx.lang.Rexx line,
netrexx.lang.Rexx string,
netrexx.lang.Rexx timer)
This method compares a text string containing wildcards with a line on the
host screen.
|
protected netrexx.lang.Rexx |
WCompPos(netrexx.lang.Rexx line,
netrexx.lang.Rexx column,
netrexx.lang.Rexx string,
netrexx.lang.Rexx timer)
This method compares a text string without wildcards with a certain position
(line and column) on the host screen.
|
protected netrexx.lang.Rexx |
WCompScreen(netrexx.lang.Rexx string,
netrexx.lang.Rexx timer)
This method compares a text string containing wildcards with the entire host
screen.
|
protected netrexx.lang.Rexx |
XDdeAdvise(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx item,
netrexx.lang.Rexx 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 netrexx.lang.Rexx |
XDdeExecute(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx 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 netrexx.lang.Rexx |
XDdeInitiate(netrexx.lang.Rexx progName,
netrexx.lang.Rexx topicName,
netrexx.lang.Rexx objectName)
This functions initiates the requested DDE conversation.
|
protected netrexx.lang.Rexx |
XDdePoke(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx item,
netrexx.lang.Rexx 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 netrexx.lang.Rexx |
XDdeRequest(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx 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 netrexx.lang.Rexx |
XDdeTerminate(netrexx.lang.Rexx hConv)
This functions submits a request to the DDE Engine to terminate the DDE
conversation identified by hConv.
|
protected netrexx.lang.Rexx |
XDdeUnadvise(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx 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 netrexx.lang.Rexx |
XDdeUpdate(netrexx.lang.Rexx topic,
netrexx.lang.Rexx item,
netrexx.lang.Rexx data)
This functions notifies the DDE Engine that the data for Topic, item has
changed to Data.
|
protected netrexx.lang.Rexx |
xrange(netrexx.lang.Rexx from,
netrexx.lang.Rexx to)
Implementation of the REXX XRANGE function for NetRexx.
|
public NetRexxMigration()
public void setWorker(PhantomWorker p)
setWorker in interface ObjectCallingpublic PhantomWorker getWorker()
getWorker in interface ObjectCallingpublic void setVirtualInterface(VirtualInterface vI)
setVirtualInterface in interface ObjectCallingpublic VirtualInterface getVirtualInterface()
getVirtualInterface in interface ObjectCallingpublic void setReturnString(String s)
setReturnString in interface ObjectCallingpublic void setReturnString(netrexx.lang.Rexx s)
public String getReturnString()
getReturnString in interface ObjectCallingpublic void start(String argId, int argMsg, String argStr) throws Exception
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 and QMSG.
Not supported messages are DDEPOKE, DDEEXEC, DDEREQ, DDEVAL, DDECONN, DDEERR, DDEDATA).
start in interface ObjectCallingExceptionpublic netrexx.lang.Rexx start(netrexx.lang.Rexx argId,
netrexx.lang.Rexx argMsg,
netrexx.lang.Rexx argStr)
throws Exception
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.
Exceptionprotected netrexx.lang.Rexx HostConnect(netrexx.lang.Rexx sessionID)
The ID of the host session is a letter from A to Z or "." to disconnect 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 the 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.
HostDisconnect(),
HostGetSession()protected netrexx.lang.Rexx HostDisconnect()
Returns: Always zero.
HostConnect(netrexx.lang.Rexx),
HostGetSession()protected netrexx.lang.Rexx HostGetSession()
Returns:
'A' to 'Z' if connected to host session. space ' ' or period '.' if disconnected from all host sessions.
HostConnect(netrexx.lang.Rexx),
HostDisconnect()protected netrexx.lang.Rexx HostError()
Returns:
0 = No error. 1 = Communication error with host.
protected netrexx.lang.Rexx HostSetTimeout(netrexx.lang.Rexx timeoutValue)
throws IllegalArgumentException,
NumberFormatException
protected netrexx.lang.Rexx HostGetTimeout()
protected netrexx.lang.Rexx HostGetRow()
HostGetCol()protected netrexx.lang.Rexx HostGetCol()
Return Value:
0 Unable to retrieve position. 1-nn Row number.
protected netrexx.lang.Rexx HostSetCursor(netrexx.lang.Rexx line,
netrexx.lang.Rexx column)
throws IllegalArgumentException,
NumberFormatException
Parameters:
line Cursor line (1-nn). column Cursor column (1-nn).
Return Value:
0 No error. 1 Unable to set cursor position.
IllegalArgumentExceptionNumberFormatExceptionHostGetCol(),
HostGetRow()protected netrexx.lang.Rexx HostWait(netrexx.lang.Rexx numWait)
throws IllegalArgumentException,
NumberFormatException
IllegalArgumentExceptionNumberFormatExceptionHostWaitScreen()protected netrexx.lang.Rexx HostWaitScreen()
HostWait(netrexx.lang.Rexx)protected netrexx.lang.Rexx HostSend(netrexx.lang.Rexx string,
netrexx.lang.Rexx startTimer,
netrexx.lang.Rexx stopTimer,
netrexx.lang.Rexx newMsg)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostSendDirect(netrexx.lang.Rexx string,
netrexx.lang.Rexx newMsg)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostSendFilePsw(netrexx.lang.Rexx userID)
throws IllegalArgumentException
Parameter
userID User ID file name created by Phantom Editor containing password.Returns:
0 No error. 1 Communication error with host. 2 Time-out.
protected netrexx.lang.Rexx HostGetLine(netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
protected netrexx.lang.Rexx HostGetString(netrexx.lang.Rexx line,
netrexx.lang.Rexx column,
netrexx.lang.Rexx length)
throws IllegalArgumentException,
NumberFormatException
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).
protected netrexx.lang.Rexx HostSetFld(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx data,
netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostGetFld(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostGetFldClr(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostGetScreen()
protected netrexx.lang.Rexx HostGetLastErr(netrexx.lang.Rexx clear)
throws IllegalArgumentException,
NumberFormatException
Setting the clear flag will clear the error message.
Returns last error message as a string or empty string if no error message exists.
protected netrexx.lang.Rexx HostGetFldAttr(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostGetFldLen(netrexx.lang.Rexx screenName,
netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostGetCurrFld()
It will return a string consisting of the current field name and line number, or it will return an empty string.
protected netrexx.lang.Rexx HostSetCursorToFld(netrexx.lang.Rexx fieldName,
netrexx.lang.Rexx lineOffset)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx HostHideSession(netrexx.lang.Rexx hideFlag)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx MacroPlay(netrexx.lang.Rexx macroName,
netrexx.lang.Rexx[] arguments)
throws IllegalArgumentException
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 Java 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.
IllegalArgumentExceptionprotected netrexx.lang.Rexx ScrComp(netrexx.lang.Rexx screenName)
throws IllegalArgumentException
Return values:
0 Screen matches. 1 General error. 2 Time-out. 4 No match.
IllegalArgumentExceptionScrWait(netrexx.lang.Rexx),
ScrMultiWait(netrexx.lang.Rexx[])protected netrexx.lang.Rexx ScrWait(netrexx.lang.Rexx screenName)
throws IllegalArgumentException
The maximum waiting period is the current time-out.
Return values:
0 Screen found. 1 General error. 2 Time-out.
IllegalArgumentExceptionScrComp(netrexx.lang.Rexx),
ScrMultiWait(netrexx.lang.Rexx[])protected netrexx.lang.Rexx ScrMultiWait(netrexx.lang.Rexx[] screenNames)
throws IllegalArgumentException
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.
protected netrexx.lang.Rexx ScrMatch()
The return value specifies a number of screens that match. Then use the function ScrGetNext to find the name of the screens.
ScrGetNext()protected netrexx.lang.Rexx ScrGetNext()
Returns empty string if no more screens matches.
ScrMatch()protected netrexx.lang.Rexx PanCreate(netrexx.lang.Rexx panelID)
throws IllegalArgumentException
Return value:
0 OK. 1 Error.
IllegalArgumentExceptionPanDestroy(),
PanPreload(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanPreload(netrexx.lang.Rexx panelID)
throws IllegalArgumentException
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.
IllegalArgumentExceptionPanCreate(netrexx.lang.Rexx),
PanDestroy()protected netrexx.lang.Rexx PanProcess()
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 Phantom is en route to
being exited.
PanEnd(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanEnd(netrexx.lang.Rexx string)
throws IllegalArgumentException
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.
IllegalArgumentExceptionPanProcess()protected netrexx.lang.Rexx PanDestroy()
Note: a main panel cannot be destroyed.
Return value:
0 OK. 1 Error.
protected netrexx.lang.Rexx PanRemove()
PanDestroy()protected netrexx.lang.Rexx PanHostInhibit(netrexx.lang.Rexx inhibitState)
throws IllegalArgumentException,
NumberFormatException
Return value:
0 OK. 1 Error.Example:
PanHostInhibit(1)
PanLock(1)
rc = HostSend('@E')
rc = HostWait()
fldname = HostGetFld(null,"FLDNAME")
rc = HostSend('@3')
rc = HostWait()
PanHostInhibit(0)
PanLock(0)
IllegalArgumentExceptionNumberFormatExceptionPanLock(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanLock(netrexx.lang.Rexx lockState)
throws IllegalArgumentException,
NumberFormatException
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)
IllegalArgumentExceptionNumberFormatExceptionPanHostInhibit(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanSetCtlData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx data)
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 Phantom Developers Reference.
Return value:
0 OK. 1 Error. 9 Error, control not found.
PanGetCtlData(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanGetCtlData(netrexx.lang.Rexx controlID)
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 Phantom Developers Reference.
protected netrexx.lang.Rexx PanSetCtlStyle(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx style)
throws IllegalArgumentException,
NumberFormatException
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.
IllegalArgumentExceptionNumberFormatExceptionPanGetCtlStyle(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanGetCtlStyle(netrexx.lang.Rexx controlID)
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.
protected netrexx.lang.Rexx PanSetCtlClr(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx foreground,
netrexx.lang.Rexx background)
throws IllegalArgumentException,
NumberFormatException
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 Phantom Developers Reference.
Return value:
0 OK. 1 Error. 9 Error, control not found.
protected netrexx.lang.Rexx PanListInsertData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx line,
netrexx.lang.Rexx data)
throws IllegalArgumentException,
NumberFormatException
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 Phantom Developers Reference.
This function can also be used with combination boxes.
Return value:
0 OK. 1 Error. 9 Error, control not found.
IllegalArgumentExceptionNumberFormatExceptionPanListDelete(netrexx.lang.Rexx, netrexx.lang.Rexx),
PanListClear(netrexx.lang.Rexx),
PanListSetData(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
PanListSetFld(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx)protected netrexx.lang.Rexx PanListDelete(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx line)
throws IllegalArgumentException,
NumberFormatException
This function can also be used with combination boxes.
Return value:
nn Number of lines remaining in the list box or combination box.
protected netrexx.lang.Rexx PanListClear(netrexx.lang.Rexx controlID)
throws IllegalArgumentException
This function can also be used with combination boxes.
Return value:
0 OK. 1 Error. 9 Error, control not found.
protected netrexx.lang.Rexx PanListSetSel(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx line,
netrexx.lang.Rexx selectionState)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx PanListGetSel(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx prevLine)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx PanListGetData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx PanListFromFile(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx fileName)
throws IllegalArgumentException
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.
protected netrexx.lang.Rexx PanListToFile(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx fileName)
throws IllegalArgumentException
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 Phantom Developers Reference.
This function can also be used with combination boxes.
Return value:
0 OK. 1 Error. 9 Error, control not found.
protected netrexx.lang.Rexx PanListGetFld(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo,
netrexx.lang.Rexx columnNo)
throws IllegalArgumentException,
NumberFormatException
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.
protected netrexx.lang.Rexx PanListSetFld(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo,
netrexx.lang.Rexx columnNo,
netrexx.lang.Rexx data)
throws IllegalArgumentException,
NumberFormatException
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 Phantom Developers Reference.
Return value:
0 OK. 1 Error. 9 Error, control not found.
protected netrexx.lang.Rexx PanListSetData(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx lineNo,
netrexx.lang.Rexx data)
throws IllegalArgumentException,
NumberFormatException
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 Phantom Developers Reference.
Return value:
0 OK. 1 Error. 9 Error, control not found.
protected netrexx.lang.Rexx PanListGetNum(netrexx.lang.Rexx controlID)
throws IllegalArgumentException
This function can also be used with combination boxes.
protected netrexx.lang.Rexx PanCheckSet(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx checkState)
throws IllegalArgumentException,
NumberFormatException
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.
IllegalArgumentExceptionNumberFormatExceptionPanCheckGet(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanCheckGet(netrexx.lang.Rexx controlID)
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.
protected netrexx.lang.Rexx PanGetText(netrexx.lang.Rexx textID)
throws IllegalArgumentException
IllegalArgumentExceptionPanXlate(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanXlate(netrexx.lang.Rexx text)
throws IllegalArgumentException
The string is empty if no matching translation is found.
IllegalArgumentExceptionPanGetText(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanSetFocus(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx selectControl)
throws IllegalArgumentException,
NumberFormatException
selectControl can be 0 or 1 if the control should
be selected.
Return value:
0 OK. 1 Error. 9 Error, control not found.
IllegalArgumentExceptionNumberFormatExceptionPanSelectCurrCtl()protected netrexx.lang.Rexx PanSelectCurrCtl()
E.g. it is used to show the user that an error message has occurred.
Return value:
0 OK. 1 Error.
protected netrexx.lang.Rexx PanUpdate()
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.
protected netrexx.lang.Rexx PanSetCurFromHost()
Return value:
0 OK. 1 Error, unable to position cursor.
protected netrexx.lang.Rexx PanSetPanelFromHost(netrexx.lang.Rexx[] panels)
throws IllegalArgumentException
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.
IllegalArgumentExceptionPanSetCurFromHost(),
PanSelectCurrCtl()protected netrexx.lang.Rexx PanChart(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx function,
netrexx.lang.Rexx data)
throws IllegalArgumentException
For a list of functions, data and return values, see the Business Graphics section in the Phantom Hurricane documentation (7.13 Business Graphics in the Developers Reference).
Return value:
0 OK. 9 Error, control not found. other See the Phantom Hurricane documentation.
IllegalArgumentExceptionprotected netrexx.lang.Rexx PanComboFromFile(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx fileName)
throws IllegalArgumentException
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.
protected netrexx.lang.Rexx PanGetCurrPanel()
protected netrexx.lang.Rexx PanCallCtl(netrexx.lang.Rexx controlID)
throws IllegalArgumentException
controlID.
Control IDs may reference a control on any created panel.
Return value:
0 OK. 9 Error, control not found.
IllegalArgumentExceptionprotected netrexx.lang.Rexx PanFormatText(netrexx.lang.Rexx text)
throws IllegalArgumentException
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.
IllegalArgumentExceptionPanGetText(netrexx.lang.Rexx),
PanXlate(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanGetDllExt(netrexx.lang.Rexx 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 Phantom 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.
protected netrexx.lang.Rexx PanNbCancelPaging()
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 Phantom 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, Phantom 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' then
return 0
// Get the page index of the destination.
dest = argStr.word(1)
// Command Jnn jumps to page nn
rc = HostSetFld(, 'PAGEJUMP', 'J'dest)
rc = HostSend('@E')
PanNbCancelPaging()
Example:
The host requires a send key F7 or F8 for each page. This is normally handled by Phantom, but we want some extra error checking.
if argMsg <> 'CMD' then
return 0
// We do the error checking now
errMsg = DoOurErrorChecking()
if ( errMsg.length > 0 )
{
PanNbCancelPaging()
Message(2, 2, errMsg)
return
}
// Get the function key to send: F7 or F8
dest = string.word(1)
prev = string.word(5)
if ( dest < prev )
sendKey = '@7'
else
sendKey = '@8'
return HostSend(sendKey)
protected netrexx.lang.Rexx PanGetCurrNbPage(netrexx.lang.Rexx controlID)
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.
protected netrexx.lang.Rexx PanSetTextFile(netrexx.lang.Rexx fileName)
throws IllegalArgumentException
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.
IllegalArgumentExceptionPanGetText(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanSetXlateFile(netrexx.lang.Rexx fileName)
throws IllegalArgumentException
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.
IllegalArgumentExceptionPanXlate(netrexx.lang.Rexx)protected netrexx.lang.Rexx PanGetFocus()
protected netrexx.lang.Rexx PanGetCtlLen(netrexx.lang.Rexx controlID)
Returns
0-nn = length.
-1 = Error, length not supported by control.
-9 = Error, control not found.
protected netrexx.lang.Rexx PanSetCtlLen(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx length)
Returns
0 = OK.
1 = Error, length not supported by control.
9 = Error, control not found.
protected netrexx.lang.Rexx SessionStart(netrexx.lang.Rexx sessionID)
throws IllegalArgumentException
Return value:
0 OK. 1 Error.
IllegalArgumentExceptionSessionStop(netrexx.lang.Rexx)protected netrexx.lang.Rexx SessionSelect(netrexx.lang.Rexx sessionID)
throws IllegalArgumentException
Return value:
0 OK. 1 Error.
IllegalArgumentExceptionSessionStart(netrexx.lang.Rexx)protected netrexx.lang.Rexx SessionStop(netrexx.lang.Rexx sessionID)
throws IllegalArgumentException
Return value:
0 OK. 1 Error.
IllegalArgumentExceptionSessionStart(netrexx.lang.Rexx)protected netrexx.lang.Rexx SessionExit()
Return value:
0 OK. 1 Error.
PanelExit()protected netrexx.lang.Rexx PanelExit()
Return value:
0 OK. 1 Error.
SessionExit()protected netrexx.lang.Rexx SessionGet()
SessionGetAll()protected netrexx.lang.Rexx SessionGetAll()
SessionGet()protected netrexx.lang.Rexx ClipbrdGet()
Return value:
data Clipboard data or empty string.
protected netrexx.lang.Rexx ClipbrdSet(netrexx.lang.Rexx data)
Parameters:
data Data to send to clipboard.
Return value:
0 No error. 1 Error.
protected netrexx.lang.Rexx TimerStart(netrexx.lang.Rexx timerNo)
throws IllegalArgumentException,
NumberFormatException
Return value:
0 OK. 1 Error.
protected netrexx.lang.Rexx TimerPause(netrexx.lang.Rexx timerNo)
throws IllegalArgumentException,
NumberFormatException
Return value:
0 OK. 1 Error.
protected netrexx.lang.Rexx TimerStop(netrexx.lang.Rexx timerNo)
throws IllegalArgumentException,
NumberFormatException
Return value:
0 OK. 1 Error.
protected netrexx.lang.Rexx TimerGet(netrexx.lang.Rexx timerNo)
throws IllegalArgumentException,
NumberFormatException
protected netrexx.lang.Rexx CompLine(netrexx.lang.Rexx line,
netrexx.lang.Rexx string)
throws IllegalArgumentException,
NumberFormatException
Parameters:
line Host line number (1-nn). string String to compare with host. timer Timer to stop (optional).
Return Value:
0 No error. 1 Communication error with host. 2 Time-out. 4 String not found.
protected netrexx.lang.Rexx WCompLine(netrexx.lang.Rexx line,
netrexx.lang.Rexx string,
netrexx.lang.Rexx timer)
throws IllegalArgumentException,
NumberFormatException
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 (optional).
Return Value:
0 No error. 1 Communication error with host. 2 Time-out.
protected netrexx.lang.Rexx CompPos(netrexx.lang.Rexx line,
netrexx.lang.Rexx column,
netrexx.lang.Rexx string)
throws IllegalArgumentException,
NumberFormatException
Parameters:
line Host line number (1-nn). column Host column number (1-nn). string String to compare with host. timer Timer to stop (optional).
Return Value:
0 No error. 1 Communication error with host. 2 Time-out. 4 String not found.
protected netrexx.lang.Rexx WCompPos(netrexx.lang.Rexx line,
netrexx.lang.Rexx column,
netrexx.lang.Rexx string,
netrexx.lang.Rexx timer)
throws IllegalArgumentException,
NumberFormatException
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 (optional).
Return Value:
0 No error. 1 Communication error with host. 2 Time-out.
protected netrexx.lang.Rexx CompScreen(netrexx.lang.Rexx string)
throws IllegalArgumentException,
NumberFormatException
Parameters:
string String to compare with host. timer Timer to stop (optional).
Return Value:
0 No error. 1 Communication error with host. 2 Time-out. 4 String not found.
protected netrexx.lang.Rexx WCompScreen(netrexx.lang.Rexx string,
netrexx.lang.Rexx timer)
throws IllegalArgumentException,
NumberFormatException
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 (optional).
Return Value:
0 No error. 1 Communication error with host. 2 Time-out.
protected netrexx.lang.Rexx DdeExecute(netrexx.lang.Rexx dde_nn,
netrexx.lang.Rexx command)
throws IllegalArgumentException,
NumberFormatException
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.
IllegalArgumentExceptionNumberFormatExceptionDdeInitiate(netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdeInitiate(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
DdePoke(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdePoke(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
DdeTerminate(netrexx.lang.Rexx),
XDdeTerminate(netrexx.lang.Rexx)protected netrexx.lang.Rexx DdeInitiate(netrexx.lang.Rexx programName,
netrexx.lang.Rexx 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:
excel = DdeInitiate('Excel','DEMO.XLS')
DdeExecute(netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdeExecute(netrexx.lang.Rexx, netrexx.lang.Rexx),
DdePoke(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdePoke(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
DdeTerminate(netrexx.lang.Rexx),
XDdeTerminate(netrexx.lang.Rexx)protected netrexx.lang.Rexx DdePoke(netrexx.lang.Rexx dde_nn,
netrexx.lang.Rexx location,
netrexx.lang.Rexx data)
throws IllegalArgumentException,
NumberFormatException
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:
rc = DdePoke(excel,'R2C4','123')
IllegalArgumentExceptionNumberFormatExceptionDdeExecute(netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdeExecute(netrexx.lang.Rexx, netrexx.lang.Rexx),
DdeInitiate(netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdeInitiate(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
DdeTerminate(netrexx.lang.Rexx),
XDdeTerminate(netrexx.lang.Rexx)protected netrexx.lang.Rexx DdeTerminate(netrexx.lang.Rexx dde_nn)
throws IllegalArgumentException,
NumberFormatException
Parameters:
dde_nn Handle retrieved from DdeInitiate.
Return Value:
0 OK.
1 DDE communication error.
IllegalArgumentExceptionNumberFormatExceptionDdeExecute(netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdeExecute(netrexx.lang.Rexx, netrexx.lang.Rexx),
DdeInitiate(netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdeInitiate(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
DdePoke(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx),
XDdePoke(netrexx.lang.Rexx, netrexx.lang.Rexx, netrexx.lang.Rexx)protected netrexx.lang.Rexx XDdeAdvise(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx item,
netrexx.lang.Rexx flags)
throws IllegalArgumentException,
NumberFormatException
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:
hrAdv = XDdeAdvise(hcExcel, 'R4C2', '0')
protected netrexx.lang.Rexx XDdeExecute(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx command)
throws IllegalArgumentException,
NumberFormatException
Parameters:
hConv Handle that identifies the requested DDE conversation. Command Command string.
Return Value:
0 Request not submitted (Error).
hReq Request handle.
Example:
hReq = XDdeExecute(hcServer, 'OPEN REPORT')
protected netrexx.lang.Rexx XDdeInitiate(netrexx.lang.Rexx progName,
netrexx.lang.Rexx topicName,
netrexx.lang.Rexx objectName)
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:
hcExcel = XDdeInitiate('Excel', 'DEMO.XLS', 'DEMO')
XDdeTerminate(netrexx.lang.Rexx)protected netrexx.lang.Rexx XDdePoke(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx item,
netrexx.lang.Rexx data)
throws IllegalArgumentException,
NumberFormatException
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:
hReq = XDdePoke(hcExcel, 'R2C3', '42')
protected netrexx.lang.Rexx XDdeRequest(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx item)
throws IllegalArgumentException,
NumberFormatException
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:
hReq = XDdeRequest(hcExcel, 'R4C2')
protected netrexx.lang.Rexx XDdeTerminate(netrexx.lang.Rexx hConv)
throws IllegalArgumentException,
NumberFormatException
Parameters:
hConv Handle that identifies the requested DDE conversation.
Return Value:
0 Request submitted.
non-zero Request not submitted (Error).
Example:
rc = XDdeTerminate(hcExcel)
protected netrexx.lang.Rexx XDdeUnadvise(netrexx.lang.Rexx hConv,
netrexx.lang.Rexx hReq)
throws IllegalArgumentException,
NumberFormatException
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:
rc = XDdeUnadvise(hcExcel, hrAdv)
protected netrexx.lang.Rexx XDdeUpdate(netrexx.lang.Rexx topic,
netrexx.lang.Rexx item,
netrexx.lang.Rexx data)
Parameters:
Topic Topic string.
Item Item string.
Data Data string.
Return Value:
0 OK.
non-zero Error.
Example:
rc = XDdeUpdate('STATUS', 'PROC1', 'READY')
protected netrexx.lang.Rexx FileCreate(netrexx.lang.Rexx fileName)
throws IllegalArgumentException
Return value:
0 OK.
1 Unable to create file: incorrect file name, file is locked
or file attribute is read-only.
IllegalArgumentExceptionFileAppend(netrexx.lang.Rexx, netrexx.lang.Rexx)protected netrexx.lang.Rexx FileAppend(netrexx.lang.Rexx fileName,
netrexx.lang.Rexx data)
throws IllegalArgumentException
Return value:
0 OK.
1 Unable to add data to file: incorrect file name, file is locked
or file attribute is read-only.
IllegalArgumentExceptionFileCreate(netrexx.lang.Rexx)protected netrexx.lang.Rexx Message(netrexx.lang.Rexx type,
netrexx.lang.Rexx icon,
netrexx.lang.Rexx message)
throws IllegalArgumentException,
NumberFormatException
Note: At this time, only a Java 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 codeReturn 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.
protected netrexx.lang.Rexx CallObject(netrexx.lang.Rexx objectID,
netrexx.lang.Rexx controlID,
netrexx.lang.Rexx action,
netrexx.lang.Rexx string)
throws IllegalArgumentException,
NumberFormatException
If a Java macro object is called from a Java application, the Java application will be stopped until the Java macro has completed. On the other hand, if an object that is of the Phantom Macro or Java 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 Phantom 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.
protected netrexx.lang.Rexx Wait(netrexx.lang.Rexx seconds)
throws IllegalArgumentException,
NumberFormatException
protected netrexx.lang.Rexx LogonGet()
LogonSet(netrexx.lang.Rexx)protected netrexx.lang.Rexx LogonSet(netrexx.lang.Rexx logonFlag)
throws IllegalArgumentException,
NumberFormatException
IllegalArgumentExceptionNumberFormatExceptionLogonGet()protected netrexx.lang.Rexx GlobVarSet(netrexx.lang.Rexx varName,
netrexx.lang.Rexx data)
throws IllegalArgumentException
Return value:
0 No error. 1 Error, cannot set the variable.
protected netrexx.lang.Rexx GlobVarGet(netrexx.lang.Rexx varName)
throws IllegalArgumentException
If the global variable cannot be retrieved, an empty string is returned.
protected netrexx.lang.Rexx GlobVarDelete(netrexx.lang.Rexx varName)
throws IllegalArgumentException
Return value:
0 No error. 1 Error, cannot delete the variable. 9 Variable not found.
protected netrexx.lang.Rexx SessVarSet(netrexx.lang.Rexx varName,
netrexx.lang.Rexx data)
throws IllegalArgumentException
Return value:
0 No error. 1 Error, cannot set the variable.
IllegalArgumentExceptionSessVarDelete(netrexx.lang.Rexx),
SessVarGet(netrexx.lang.Rexx),
GlobVarGet(netrexx.lang.Rexx),
GlobVarSet(netrexx.lang.Rexx, netrexx.lang.Rexx),
GlobVarDelete(netrexx.lang.Rexx),
SessionStart(netrexx.lang.Rexx),
SessionStop(netrexx.lang.Rexx),
SessionSelect(netrexx.lang.Rexx)protected netrexx.lang.Rexx SessVarGet(netrexx.lang.Rexx varName)
throws IllegalArgumentException
If the session variable cannot be retrieved, an empty string is returned.
IllegalArgumentExceptionSessVarDelete(netrexx.lang.Rexx),
SessVarSet(netrexx.lang.Rexx, netrexx.lang.Rexx),
GlobVarGet(netrexx.lang.Rexx),
GlobVarSet(netrexx.lang.Rexx, netrexx.lang.Rexx),
GlobVarDelete(netrexx.lang.Rexx),
SessionStart(netrexx.lang.Rexx),
SessionStop(netrexx.lang.Rexx),
SessionSelect(netrexx.lang.Rexx)protected netrexx.lang.Rexx SessVarDelete(netrexx.lang.Rexx varName)
throws IllegalArgumentException
Return value:
0 No error. 1 Error, cannot delete variable. 9 Variable not found.
IllegalArgumentExceptionSessVarGet(netrexx.lang.Rexx),
SessVarSet(netrexx.lang.Rexx, netrexx.lang.Rexx),
GlobVarGet(netrexx.lang.Rexx),
GlobVarSet(netrexx.lang.Rexx, netrexx.lang.Rexx),
GlobVarDelete(netrexx.lang.Rexx),
SessionStart(netrexx.lang.Rexx),
SessionStop(netrexx.lang.Rexx),
SessionSelect(netrexx.lang.Rexx)protected netrexx.lang.Rexx Beep(netrexx.lang.Rexx frequency,
netrexx.lang.Rexx duration)
Toolkit.getDefaultToolkit().beep() sound.
Return value:
0 No error.
protected netrexx.lang.Rexx Datatype(netrexx.lang.Rexx variable)
The value of DATATYPE(56) is NUM
The value of DATATYPE(6.2) is NUM
The value of DATATYPE('$5.50') is CHAR
public netrexx.lang.Rexx Random(netrexx.lang.Rexx max)
The magnitude of the range (that is, max minus min) must not exceed 100000.
Here are some examples:
RANDOM() = 305 RANDOM(2) = 0
public netrexx.lang.Rexx CharIn(netrexx.lang.Rexx name,
netrexx.lang.Rexx position,
netrexx.lang.Rexx length)
throws IllegalArgumentException,
NumberFormatException
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 callNote: CharIn returns all characters that appear in the stream including control characters such as line feed, carriage return, and end of file.
public netrexx.lang.Rexx CharOut(netrexx.lang.Rexx name,
netrexx.lang.Rexx chars,
netrexx.lang.Rexx position)
throws IllegalArgumentException,
NumberFormatException
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.
The string can be omitted for persistent streams. In this case, the write position is set to the value of start that was given, no characters are written to the stream, and 0 is returned. If neither start nor string are given, the write position is set to the end of the stream. This use of CharOut can also have the side effect of closing or fixing the file in environments which support this concept. Again, 0 is returned. If you do not specify start or string, the stream is closed. Again, 0 is returned.
Processing of the program normally stops until the output operation is effectively complete. If, however, it is impossible for all the characters to be written, the NOTREADY condition is raised and CharOut returns with the number of characters that could not be written (the residual count).
Here are some examples:
CHAROUT(myfile,'Hi') = 0 -- normally CHAROUT(myfile,'Hi',5) = 0 -- normally CHAROUT(myfile,,6) = 0 -- now at char 6 CHAROUT(myfile) = 0 -- at end of stream
protected netrexx.lang.Rexx Chars(netrexx.lang.Rexx name)
throws IllegalArgumentException
Here are some examples:
CHARS(myfile) = 42 -- perhaps CHARS(nonfile) = 0 -- perhaps
IllegalArgumentExceptionpublic netrexx.lang.Rexx FileSpec(netrexx.lang.Rexx part,
netrexx.lang.Rexx name)
throws IllegalArgumentException
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 "\OS2\UTIL\"
say FILESPEC("name",thisfile) -- says "EXAMPLE.EXE"
IllegalArgumentExceptionpublic netrexx.lang.Rexx LineIn(netrexx.lang.Rexx name,
netrexx.lang.Rexx position,
netrexx.lang.Rexx length)
throws IllegalArgumentException,
NumberFormatException
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).
public netrexx.lang.Rexx LineOut(netrexx.lang.Rexx name,
netrexx.lang.Rexx data,
netrexx.lang.Rexx line)
throws IllegalArgumentException,
NumberFormatException
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
public netrexx.lang.Rexx Lines(netrexx.lang.Rexx name)
throws IllegalArgumentException
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.IllegalArgumentExceptionpublic netrexx.lang.Rexx Stream(netrexx.lang.Rexx name,
netrexx.lang.Rexx operation,
netrexx.lang.Rexx command)
throws IllegalArgumentException
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')
IllegalArgumentExceptionprotected netrexx.lang.Rexx Date(netrexx.lang.Rexx form)
Basedate Returns the number of complete days (that is, not including the
. current day) since and including the base date, January 1, 0001, in
. the format: dddddd (no leading zeros). The expression DATE(B)//7
. returns a number in the range 0-6, where 0 is Monday and 6 is Sunday.
. Note: The origin of January 1, 0001 is based on the Gregorian calendar.
. Though this calendar did not exist prior to 582, Basedate is calculated
. as if it did: 365 days per year, an extra day every four years except
. century years, and leap centuries if the century is divisible by 400.
. It does not take into account any errors in the calendar system that
. created the Gregorian calendar originally.
.
Days Returns the number of days, including the current day, so far in this
. year in the format: ddd (no leading zeros)
.
European Returns date in the format: dd/mm/yy.
.
Language Returns date in an implementation and language dependent or local date
. format. If no local format is available, the default format is returned.
. Note: This format is intended to be used as a whole; REXX programs should
. not make any assumptions about the form or content of the returned string.
.
Month Returns full English name of the current month, for example, August
.
Normal Returns date in the default format: dd mon yyyy
.
Ordered Returns date in the format: yy/mm/dd (suitable for sorting, and so on.)
.
Sorted Returns date in the format: yyyymmdd (suitable for sorting, and so on.)
.
Usa Returns date in the format: mm/dd/yy
.
Weekday Returns the English name for the day of the week, in mixed case. For
example, Tuesday.
Here are some examples:
DATE('') = '27 Aug 1988' -- as DATE('N')
DATE('B') = 725975
DATE('D') = 240
DATE('E') = '27/08/88'
DATE('L') = '27 August 1988'
DATE('M') = 'August'
DATE('N') = '27 Aug 1988'
DATE('O') = '88/08/27'
DATE('S') = '19880827'
DATE('U') = '08/27/88'
DATE('W') = 'Saturday'
Note: Calls to DATE or TIME in one expression can cause different a time stamps to be used.protected netrexx.lang.Rexx Time(netrexx.lang.Rexx form)
04:41:37. You can use the following options (for which
only the capitalized letter is needed) to obtain alternative formats, or to gain access to the
elapsed-time clock:
Civil Returns hh:mmxx, the time in Civil format, in which the hours may take the . values 1 through 12, and the minutes the values 00 through 59. The minutes . are followed immediately by the letters "am" or "pm" to distinguish times . in the morning (midnight 12:00am through 11:59am) from noon and afternoon . (noon 12:00pm through 11:59pm). The hour will not have a leading zero. The . minute field shows the current minute (rather than the nearest minute) for . consistency with other TIME results. . Elapsed Returns sssssssss.uu0000, the number of seconds.hundredths since the elapsed . time clock was started or reset (see below). The returned number has no . leading zeros, but always has four trailing zeros in the decimal portion. It . is not affected by the setting of NUMERIC DIGITS. . Hours Returns number of hours since midnight in the format hh (no leading zeros). . Long Returns time in the format hh:mm:ss.uu0000 (where uu is the fraction of . seconds in hundredths of a second). . Minutes Returns number of minutes since midnight in the format: mmmm (no leading . zeros). . Normal Returns the time in the default format hh:mm:ss, as described above. . Reset Returns sssssssss.uu0000, the number of seconds.hundredths since the elapsed . time clock was started or reset (see below) and also resets the elapsed-time . clock to zero. The returned number has no leading zeros, but always has four . trailing zeros in the decimal portion. . Seconds Returns number of seconds since midnight in the format sssss (no leading zeros).Here are some examples:
TIME('L') = '16:54:22.120000' -- Perhaps
TIME('') = '16:54:22'
TIME('H') = '16'
TIME('M') = '1014' -- 54 + 60*16
TIME('S') = '60862' -- 22 + 60*(54+60*16)
TIME('N') = '16:54:22'
TIME('C') = '4:54pm'
The Elapsed-Time Clock
The elapsed-time clock may be used for measuring real time intervals. On the first call to the elapsed-time clock, the clock is started, and both TIME('E') and TIME('R') will return 0. The clock is saved across internal routine calls, which is to say that an internal routine inherits the time clock its caller started. Any timing the caller is doing is not affected even if an internal routine resets the clock.
Here is an example of the elapsed-time clock:
TIME('E') = 0 -- The first call, pause of one second here
TIME('E') = 1.020000 -- or thereabouts, pause of one second here
TIME('R') = 2.030000 -- or thereabouts, pause of one second here
TIME('R') = 1.050000 -- or thereabouts
protected netrexx.lang.Rexx Bitand(netrexx.lang.Rexx first,
netrexx.lang.Rexx second,
netrexx.lang.Rexx pad)
protected netrexx.lang.Rexx Bitor(netrexx.lang.Rexx first,
netrexx.lang.Rexx second,
netrexx.lang.Rexx pad)
protected netrexx.lang.Rexx Bitxor(netrexx.lang.Rexx first,
netrexx.lang.Rexx second,
netrexx.lang.Rexx pad)
protected netrexx.lang.Rexx xrange(netrexx.lang.Rexx from,
netrexx.lang.Rexx to)
XRANGE returns a string of all one-byte codes between and including the values start and end. The default value for start is '00'x, and the default value for end is 'FF'x. If start is greater than end, the values wrap from 'FF'x to '00'x. If specified, start and end must be single characters.
protected netrexx.lang.Rexx Report(netrexx.lang.Rexx com,
netrexx.lang.Rexx p1,
netrexx.lang.Rexx p2,
netrexx.lang.Rexx p3,
netrexx.lang.Rexx p4,
netrexx.lang.Rexx p5)
throws IllegalArgumentException
Return value:
0 No error. 1 Error executing command 9 Undefined report command.
protected netrexx.lang.Rexx SendEmail(netrexx.lang.Rexx com,
netrexx.lang.Rexx p1)
throws IllegalArgumentException
Return value:
0 No error. 1 Error executing command, use command "GetLastError" for error message. 9 Undefined mail command.
IllegalArgumentExceptionprotected netrexx.lang.Rexx SendSMS(netrexx.lang.Rexx com,
netrexx.lang.Rexx p1,
netrexx.lang.Rexx p2)
throws IllegalArgumentException
Return value:
0 No error. 1 Error executing command, use command "GetLastError" for error message. 9 Undefined SMS command.
IllegalArgumentExceptionprotected netrexx.lang.Rexx ShowDocument(netrexx.lang.Rexx url,
netrexx.lang.Rexx target)
throws IllegalArgumentException
Return value:
0 No error. 1 Error showing document.
IllegalArgumentExceptionprotected netrexx.lang.Rexx ClientExecute(netrexx.lang.Rexx async,
netrexx.lang.Rexx command,
netrexx.lang.Rexx data)
protected netrexx.lang.Rexx translate(netrexx.lang.Rexx string,
netrexx.lang.Rexx tableo,
netrexx.lang.Rexx tablei,
netrexx.lang.Rexx pad)
throws IllegalArgumentException
TRANSLATE(string [, [tableo] [, [tablei] [,pad] ] ])TRANSLATE translates characters in string to other characters, or reorders characters in a string. If neither translate table is given, string is simply translated to uppercase (for example, a lowercase a-z to an uppercase A-Z).
The output table is tableo and the input translate table is tablei (the default is XRANGE('00'x,'FF'x)). The output table defaults to the null string and is padded with pad or truncated as necessary. The default pad is a blank. The tables can be of any length; the first occurrence of a character in the input table is the one that is used if there are duplicates.
Here are some examples:
TRANSLATE('abcdef') = 'ABCDEF'
TRANSLATE('abbc','#','b') = 'a##c'
TRANSLATE('abcdef','12','ec') = 'ab2d1f'
TRANSLATE('abcdef','12','abcd','.') = '12..ef'
TRANSLATE('4123','abcd','1234') = 'dabc'
Note: The last example shows how to use the TRANSLATE function to reorder the
characters in a string. In the example, the last character of any four-character
string specified as the second argument would be moved to the beginning of the string.IllegalArgumentExceptionprotected netrexx.lang.Rexx ExecuteProcess(netrexx.lang.Rexx dir,
netrexx.lang.Rexx useRuntimeDir,
netrexx.lang.Rexx cmdLine)
A return code < 0 indicates an error.
protected netrexx.lang.Rexx CreateTempFile()
protected netrexx.lang.Rexx RemoveTempFile(netrexx.lang.Rexx fileName)
protected netrexx.lang.Rexx DeleteFile(netrexx.lang.Rexx fileName)
protected netrexx.lang.Rexx PanSetCtlProperty(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx property,
netrexx.lang.Rexx data)
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.
protected netrexx.lang.Rexx PanGetCtlProperty(netrexx.lang.Rexx controlID,
netrexx.lang.Rexx property)
If ControlID is *PANEL, the text for the current panel is
retrieved. If it is *APP the text for the application panel is retrieved.
protected netrexx.lang.Rexx PanSetRatioAndFontScaling(netrexx.lang.Rexx ratioX,
netrexx.lang.Rexx ratioY,
netrexx.lang.Rexx doScaleFonts)
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.
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, 1=scale, 0=don't scale.protected netrexx.lang.Rexx PanEnableClientProcessing(netrexx.lang.Rexx on)
on - true to enable processing, false to disable it.protected netrexx.lang.Rexx PanIsClientProcessingEnabled()
protected netrexx.lang.Rexx StartLog()
protected netrexx.lang.Rexx StopLog()
protected netrexx.lang.Rexx RotateLog()
protected netrexx.lang.Rexx LogMsg(String msg)
Phantom® and NetPhantom® are registered trademarks of Mindus SARL.
© © Mindus SARL, 2024. All rights reserved.