home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 18 REXX
/
18-REXX.zip
/
rexxio46.zip
/
REXXIO.INF
(
.txt
)
< prev
next >
Wrap
OS/2 Help File
|
2000-07-16
|
211KB
|
7,034 lines
ΓòÉΓòÉΓòÉ 1. REXXIO Index ΓòÉΓòÉΓòÉ
REXX I/O Library Version 4.6
Contents
Version Notice
Introduction
Function List
Getting Started - Initialising REXXIO.
Section 01 File Functions.
Section 02 Directory Functions
Section 03 Search Functions
Section 04 Window Functions.
Section 05 Keyboard/Mouse Event Functions.
Section 06 Rexx Functions.
Section 07 Registry Functions.
Section 08 Global Stem Variable Functions.
Section 09 General Functions.
Section 10 Comms Functions.
Section 11 Event Functions.
Section 12 Internet Functions.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 2. Introduction ΓòÉΓòÉΓòÉ
Introduction
REXXIO is a general REXX Input/Output library to aid general File I/O
and Window/Keyboard/Mouse manipulation.
The version notice that pops up the first time REXXIO is used does not
appear if "Modular And Integrated Design" is installed. The
getrexxioversion function returns the REXXIO version information.
* Functions with and asterisk after the function name require a licensed
copy of "Modular And Integrated Design" to be installed.
Contents.
ΓòÉΓòÉΓòÉ 3. Function List ΓòÉΓòÉΓòÉ
Function List
Contents.
Getting Started - Initializing REXXIO
rexxioinit Registers all REXXIO functions.
Section 01 File Functions
newfile Creates new file NewFilename.
removefile Delete File Filename.
copyfile Copies Filename1 to Filename2.
appendfile Appends Filename1 to Filename2.
copycontentsfile Copies contents of Filename1 to Filename2.
copytempfile Copies Filename to a temporary file in temporary
directory or Directory if specified.
movefile Moves OldFilename to NewFilename.
reversefile Reverses line order of all lines in Filename.
getfilesize Returns length of Filename.
setfilesize Sets Filename size to Size.
getshortname Gets short path form of a specified path.
getfullpathname Returns current directory plus Filename.
getfilepart Returns Filename part of Fully Qualified path\name.
getdirpart Returns Directory part of Fully Qualified path\name.
findfile Returns Fully Qualified path\name of File.
getnolines Gets number of lines in Filename.
getlinepos Gets position of line LineNumber in file Filename.
getline Gets contents of line LineNumber in file Filename.
getlineatpos* Gets contents of line at position in file Filename.
getstring Gets String from Filename at Position.
insertstring Inserts String into Filename at Position.
insertstringcrlf Inserts String plus cr/lf at Position in Filename.
deletestring Deletes Length chars at Position from Filename.
insertline Inserts line into Filename.
deleteline Deletes line from Filename.
insertfile* Insert Filename at a given point.
newfilefromposition* Creates new file NewFilename with data from
Position.
getnocsvcolumns* Gets the number of columns in a CSV tab or comma
delimited line.
getcsvcolumn* Gets the nth column entry from a CSV tab or comma
delimited line.
replacecsvcolumn* Replaces the nth column entry into a CSV tab or
comma delimited line.
newtempfile* Creates new temporary file.
existfile* Tests existance of a file.
renamefile* Rename a file.
addquotestoline* Add quotes to each end of a line of text.
addsinglequotestoline* Add single quotes to each end of a line of text
and double up and single quotes within the line.
adddoublequotestoline* Add double quotes to each end of a line of text
and double up and double quotes within the line.
stripquotesfromline* Strips quotes from each end of a line of text.
getkeyfromcsvfilecol* Gets unique key from column in CSV file.
readfiletostem* Reads a file into a stem variable.
insertfilefromstem* Inserts lines in to a file from a stem variable.
inusefile* Tests whether a file is is use.
getcharatpos* Gets character at position in file Filename.
getwordatpos* Gets word at position in file Filename.
fixlinefeeds* Replaces single line feeds with carriage return line
feed.
fixlinefeedsrememptylines* Replaces single line feeds with carriage
return line feed and removes empty lines.
getfilereplacetext* Replace all occurences of one string with another.
importfilestofile* Imports a list of files into one file.
exportfilesfromfile* Exports a list of files from one file.
delexpfilesfromfile* Deletes a list of files previously exported from
one file.
createsetupexe* Create a setup executable file.
readfiletovariable* Reads a file to a rexx variable.
openfile* Open file.
closefile* Close file.
setfilepointer* Positions a file pointer within a file.
readfile* Reads from an open file.
writefile* Writes to an open file.
setendoffile* Writes an EOF marker to the file.
emptyfile* Deletes the contents of a file.
copytoclipboardfromfile* Copy to clipboard from file.
copytoclipboardfrommle* Copy to clipboard from mle.
pastetomlefromfile* Paste to mle from file.
pastetomlefromclipboard* Paste to mle from clipboard.
pastetofilefrommle* Paste to file from mle.
pastetofilefromclipboard* Paste to file from clipboard.
changemleselectedcharformat* Change mle selected character format.
Section 02 Directory Functions
cd Changes current directory to NewDirectory.
md Creates directory NewDirectory.
rd Removes Directory.
dirfile Creates File containing info on Directory\Pattern.
dirstem Creates StemVariable containing file info on
Directory\Pattern.
dirfiledir Creates File containing directory file info on
Directory\Pattern.
dirstemdir Creates StemVariable containing directory info on
Directory\Pattern.
getshellfolders Gets all Shell Folders into StemVariable.
gettempdir Gets Temp Directory Pathname
getcurrentdir Gets current directory.
getdesktopdir Gets directory for desktop.
getdrives Gets list of logical drives into a Stem Variable.
existdir* Tests existance of a directory.
Section 03 Search Functions
searchcaseon Makes string searches in findstring case sensitive.
searchcaseoff Makes string searches in findstring non case sensitive.
findstringtofile Seaches All files matching FilenamePattern for
SearchString to Filename.
findstringtostem Seaches All files matching FilenamePattern for
SearchString to Stem Variable.
changestring Replaces ReplaceString with NewString according to
StringInfo.
filenamefrominfo* Gets filename from StringInfo.
startposfrominfo* Gets start position from StringInfo.
endposfrominfo* Gets end position from StringInfo.
Section 04 Window Functions.
toplevelwindowlist List all Top Level Windows in Stem Variable.
getwindow Return handle of window with title.
getwindowwithchild* Return handle of window with title that contains
child with text.
sendwindowtext Send text to window.
sendwindowfile* Send contents of file to window.
setwindowpos Set window position.
getwindowpos Get window position.
setwindowtopmost* Place window above all non-topmost windows.
setwindownormal* Place window above all non-topmost windows ,behind
all topmost windows.
setwindowbottom* Place window at bottom of Z order.
getforegroundwindow* Get window in the foreground.
setforegroundwindow* Place window in the foreground.
getwindowtitle* Get window title.
setwindowtitle* Set window title.
getwindowvariable* Get contents of a window to a variable.
getwindowfile* Get contents of a window to a file.
Section 05 Keyboard/Mouse Event Functions.
sendmouseevent Sends a mouse event.
starteventscapture Captures all subsequent Mouse and Keyboard Events
to Filename.
stopeventscapture Stops capture of events started by
starteventscapture.
removelastevent Removes last event from Filename.
setcapslockon Sets Caps Lock ON.
setcapslockoff Sets Caps Lock OFF.
setcoordwindow Sets all following co-ordinates relative to a window.
Section 06 Rexx Functions.
runrexxscript Executes RexxScript with optional arguments.
runrexxscriptwindow Executes RexxScript as a separate process in a
window.
runrexxscriptmin Executes RexxScript as a separate process in a
minimised window.
runtempmaidscript* Executes temporary copy of a MAID script.
runtempmaidmultiscript* Executes temporary copy of a MAID script from
a multiscript file.
Section 07 Registry Functions.
dirregistry Creates StemVariable containing info on Registry.
getkeyvalues Create StemVariable with Key values for Registry
setkeyvalue Modifies/Creates key value/data - creates key if it does
not exist
deletekey Deletes an existing key
deletekeyvalue Deletes value from a key
Section 08 Global Stem Variable Functions.
writestemlist Write to stemlist.
readstemlist Read from stemlist.
writeallstemlist Clears stemlist and writes all stem variables to
stemlist.
readallstemlist Reads all stem variable from stemlist and leaves items
on the list.
peekstemlist Read from stemlist.
readstemlistitem Read item from stemlist.
peekstemlistitem Read item from stemlist.
stemlisttofile Dump stemlist to a file.
stemlistfromfile Import file entries to stemlist.
stemvartofile Dump stem variable to a file.
stemvarfromfile Import stem variable from file.
sizeofstemlist Get no of entries in stemlist.
freestemlist Frees existing stemlist.
getstemtails* Gets tails of a stem variable.
reducestemvariable* Reduces a stem variable by removong all null
entries.
getstemidlist* Gets a list of all non NULL ID's belonging to a stem in
a stemlist.
getstemtargetlist* Gets a list of all non NULL target strings
belonging to a stem in a stemlist.
savelocalstems* Writes local stem variables to local memory.
restorelocalstems* Reads local stem variables from local memory.
Section 09 General Functions.
pause Pause in milliseconds.
beep Beeps at Frequency for Duration milliseconds.
execute Executes Filename.
syscommand* Executes System Command.
getosversion Get operating system version information.
listprinters List available printers to a stem variable.
getdefaultprinter Returns default printer.
setdefaultprinter Set default printer.
printstring* Print string to default printer.
printfile* Print file to default printer.
playwave Play a wave file.
importwindow* Import a desktop window to become a child of a parent
desktop window .
exportwindow* Export a child desktop window imported with
importwindow .
validatestringchars* Validates that a string only contains certain
characters.
removestringchars* Removes certain characters from a string.
addfuncfromfile* Add a list of functions from a file.
closethreadhandles* Close thread handles from non-active threads.
validatestringformat* Validate the format of a string.
getrexxioversion* Returns the REXXIO version information .
reformatdatestring* Reformats a date string.
messagebeep Plays a waveform sound or beeps the system speaker.
Section 10 Comms Functions.
opencommport* Open Comm Port.
closecommport* Close Comm Port.
readcommport* Read from Comm Port.
writecommport* Write to Comm Port.
readcommtofile* Read from Comm Port to file.
stopreadcommtofile* Stop Read from Comm Port to file.
writecommfromfile* Write from file to Comm Port.
writewaitreplycomm* Write to Comm Port. and wait for reply.
clearcommbuffer* Flushes the transmit buffer.
Section 11 Event Functions.
whenwinchildsettitle* When window with title/child
created/visible/invisible/destroyed then set window title.
whenwinchildrunscript* When window with title/child
created/visible/invisible/destroyed then run script.
whenfilerunscript* When file created/changed/destroyed then run
script.
whendirrunscript* When directory created/changed/destroyed then run
script.
Section 12 Internet Functions.
geturl* Get an internet url page.
geturlheader* Get an internet url page header data.
getfiletags* Get HTML tags from a file.
getfiletext* Get text without tags from a file.
getfilealttext* Get text without tags from a file and include any alt
definitions from the tags.
getnameofhost* Get name of host.
gethostipaddress* Get IP address of host.
geturlipaddress* Get IP address from URL.
geturlstructure* Get an internet url page and the pages referenced
beneath it.
Section 13 Graphic Functions.
opengraphicwindow* Create a graphic window.
closegraphicwindow* Close a graphic window.
drawwinline* Draw a line between two points.
drawwinbox* Draw a box around a point a given distance from the point.
anglearc* Draws a straight line and an arc.
arc* Draws an elliptical arc.
arcto* Draws an elliptical arc and the current position is updated.
getarcdirection* Returns the current arc direction - arc and rectangle
functions use the arc direction.
setarcdirection* Sets the drawing direction to be used for arc and
rectangle functions.
lineto* Draws a line from the current position up to, but not
including, the specified point.
moveto* Updates the current position to the specified point and
optionally returns the previous position.
polybezier* Draws one or more BВzier curves.
polybezierto* Draws one or more BВzier curves and moves the current
position to the ending point of the last BВzier curve.
polydraw* Draws a set of lines and BВzier curves.
polyline* Draws a series of lines by connecting the points specified.
polylineto* Draws one or more lines and moves the current position to
the ending point of the last line.
polypolyline* Draws multiple series of connected lines.
polygon* Draws a polygon consisting of two or more points connected by
straight lines.
polypolygon* Draws a series of closed polygons. The polygons drawn by
this function can overlap.
chord* Draws a chord (a region bounded by the intersection of an
ellipse and a line segment, called a "secant").
ellipse* Draws an ellipse. The center of the ellipse is the center of
the rectangle.
pie* Draws a pie-shaped wedge bounded by the intersection of an
ellipse and two radials.
rectangle* Draws a rectangle.
fillrect* Fills a rectangle with the specified color.
framerect* Draws a border (1 unit thick) around the specified
rectangle with the specified color.
invertrect* Inverts the color in the area within the specified
rectangle.
roundrect* Draws a rectangle with rounded corners.
textout* Writes a character string at the specified location, using
the currently selected font.
drawtext* Draws formatted text in the rectangle.
gettextextent* Computes the width and height of the specified string
of text.
settextcolor* Sets the text color.
gettextcolor* Gets the text color.
listfonts* List available fonts.
settextfont* Sets the text font.
gettextfont* Gets the text font.
setpen* Sets a pen that has the specified style, width, and color.
setbrush* Sets a brush that has the specified color.
setbackgroundcolor* Sets the current background color to the specified
color.
setbackgroundmode* Sets the background mix mode.
setneworigin* Sets the new relative window position of the x,y origin
(0,0).
getbitmapsize* Gets the dimensions of a bitmap file.
exportbitmap* Exports the rectangle as a bitmap file.
importbitmap* Imports a bitmap file into a rectangle.
getnumberoficons* Gets number of icons in a file.
exporticon* Exports the rectangle as an icon file.
importicon* Imports an icon file into a rectangle.
copyrectangle* Copies a rectangle to the clipboard as a bitmap.
pasterectangle* Pastes a bitmap from the clipboard into the specified
rectangle.
getcurrentpos* Gets the current position.
getscrollpos* Gets the current position of the scroll bars.
getscrollrange* Gets the current range of the scrollbars.
setscrollpos* Sets the current scrollbar positions.
updatedisplayon* Sets graphic display on to reflect all drawing in
real time.
updatedisplayoff* Sets graphic display off to freeze the display and
draw in memory.
ΓòÉΓòÉΓòÉ 4. Getting Started - Initialising REXXIO ΓòÉΓòÉΓòÉ
Getting Started - Initialising REXXIO
rexxioinit Registers all REXXIO functions.
Contents.
ΓòÉΓòÉΓòÉ 5. rexxioinit ΓòÉΓòÉΓòÉ
rexxioinit
Registers all REXXIO functions .
equivalent to -
ret=RxFuncAdd('newfile','REXXIO','newfile')
ret=RxFuncAdd('removefile','REXXIO','removefile')
...
ret=RxFuncAdd('setdefaultprinter','REXXIO','setdefaultprinter')
f=rexxioinit(REXXDLLPathName)
REXXDLLPathName - Optional Fully Qualified Path Name of the REXX DLL
being used
Default is "REXX.DLL"
Rexxioinit requires the name of the REXX Dynamic Link Library (REXX
interpreter) being used.
If no name is supplied it is assumed to be "REXX.DLL" in the current or
system path.
eg
ret=RxFuncAdd('rexxioinit','REXXIO','rexxioinit')
ret=rexxioinit()
If this is not the case.the fully qualified name if the REXX DLL being
used must be
passed to rexxioinit.
eg
ret=RxFuncAdd('rexxioinit','REXXIO','rexxioinit')
ret=rexxioinit("Z:\RexxPathName\MYREXX.DLL")
where Z:\RexxPathName\MYREXX.DLL is the REXX DLL in use.
NOTE: An executable file called RXIOINIT.EXE (windows only) is provided
for compatibility with some Rexx Interpreters. RXIOINIT.EXE should reside
in the same directory as REXXIO.DLL .
REXXIO.DLL executes RXIOINIT.EXE automatically if necessary
Contents.
ΓòÉΓòÉΓòÉ 6. Section 01 File Functions ΓòÉΓòÉΓòÉ
Section 01 - File Functions
newfile Creates new file NewFilename.
removefile Delete File Filename.
copyfile Copies Filename1 to Filename2.
appendfile Appends Filename1 to Filename2.
copycontentsfile Copies contents of Filename1 to Filename2.
copytempfile Copies Filename to a temporary file in temporary
directory or Directory if specified.
movefile Moves OldFilename to NewFilename.
reversefile Reverses line order of all lines in Filename.
getfilesize Returns length of Filename.
setfilesize Sets Filename size to Size.
getshortname Gets short path form of a specified path.
getfullpathname Returns current directory plus Filename.
getfilepart Returns Filename part of Fully Qualified path\name.
getdirpart Returns Directory part of Fully Qualified path\name.
findfile Returns Fully Qualified path\name of File.
getnolines Gets number of lines in Filename.
getlinepos Gets position of line LineNumber in file Filename.
getline Gets contents of line LineNumber in file Filename.
getlineatpos* Gets contents of line at position in file Filename.
getstring Gets String from Filename at Position.
insertstring Inserts String into Filename at Position.
insertstringcrlf Inserts String plus cr/lf at Position in Filename.
deletestring Deletes Length chars at Position from Filename.
insertline Inserts line into Filename.
deleteline Deletes line from Filename.
insertfile* Insert Filename at a given point.
newfilefromposition* Creates new file NewFilename with data from
Position.
getnocsvcolumns* Gets the number of columns in a CSV tab or comma
delimited line.
getcsvcolumn* Gets the nth column entry from a CSV tab or comma
delimited line.
replacecsvcolumn* Replaces the nth column entry into a CSV tab or
comma delimited line.
newtempfile* Creates new temporary file.
existfile* Tests existance of a file.
renamefile* Rename a file.
addquotestoline* Add quotes to each end of a line of text.
addsinglequotestoline* Add single quotes to each end of a line of text
and double up and single quotes within the line.
adddoublequotestoline* Add double quotes to each end of a line of text
and double up and double quotes within the line.
stripquotesfromline* Strips quotes from each end of a line of text.
getkeyfromcsvfilecol* Gets unique key from column in CSV file.
readfiletostem* Reads a file into a stem variable.
insertfilefromstem* Inserts lines in to a file from a stem variable.
inusefile* Tests whether a file is is use.
getcharatpos* Gets character at position in file Filename.
getwordatpos* Gets word at position in file Filename.
fixlinefeeds* Replaces single line feeds with carriage return line
feed.
fixlinefeedsrememptylines* Replaces single line feeds with carriage
return line feed and removes empty lines.
getfilereplacetext* Replace all occurences of one string with another.
importfilestofile* Imports a list of files into one file.
exportfilesfromfile* Exports a list of files from one file.
delexpfilesfromfile* Deletes a list of files previously exported from
one file.
createsetupexe* Create a setup executable file.
readfiletovariable* Reads a file to a rexx variable.
openfile* Open file.
closefile* Close file.
setfilepointer* Positions a file pointer within a file.
readfile* Reads from an open file.
writefile* Writes to an open file.
setendoffile* Writes an EOF marker to the file.
emptyfile* Deletes the contents of a file.
copytoclipboardfromfile* Copy to clipboard from file.
copytoclipboardfrommle* Copy to clipboard from mle.
pastetomlefromfile* Paste to mle from file.
pastetomlefromclipboard* Paste to mle from clipboard.
pastetofilefrommle* Paste to file from mle.
pastetofilefromclipboard* Paste to file from clipboard.
changemleselectedcharformat* Change mle selected character format.
Contents.
ΓòÉΓòÉΓòÉ 7. newfile ΓòÉΓòÉΓòÉ
newfile
Creates new file NewFilename .
f=newfile(NewFilename)
NewFilename - name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 8. removefile ΓòÉΓòÉΓòÉ
removefile
Delete File Filename .
f=removefile(Filename)
Filename - name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 9. copyfile ΓòÉΓòÉΓòÉ
copyfile
Copies Filename1 to Filename2
f=copyfile(Filename1,Filename2)
Filename1 - name of file1
Filename2 - name of file2
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 10. appendfile ΓòÉΓòÉΓòÉ
appendfile
Appends Filename1 to Filename2
f=appendfile(Filename1,Filename2)
Filename1 - name of file1
Filename2 - name of file2
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 11. copycontentsfile ΓòÉΓòÉΓòÉ
copycontentsfile
Copies contents of Filename1 to Filename2
f=copycontentsfile(Filename1,Filename2)
Filename1 - name of file1
Filename2 - name of file2
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 12. copytempfile ΓòÉΓòÉΓòÉ
copytempfile
Copies Filename to a temporary file in temporary directory or Directory
if specified.
Returns full Temporary Filename. .
TempFilename=copytempfile(Filename[,Directory])
Filename - name of file
Directory - optional Directory name
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 13. movefile ΓòÉΓòÉΓòÉ
movefile
Moves OldFilename to NewFilename .
f=movefile(OldFilename,NewFilename)
OldFilename - Old name of file
NewFilename - New name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 14. reversefile ΓòÉΓòÉΓòÉ
reversefile
Reverses line order of all lines in Filename -
1st line becomes last line
2nd line becomes 2nd last line
...
Last line becomes 1st line .
f=reversefile(Filename)
Filename - name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 15. getfilesize ΓòÉΓòÉΓòÉ
getfilesize
Returns size of a file.
size=getfilesize(Filename)
Filename - name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 16. setfilesize ΓòÉΓòÉΓòÉ
setfilesize
Sets the size if a file.
f=setfilesize(Filename,Size)
Filename - name of file
Size - size in bytes
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 17. getshortname ΓòÉΓòÉΓòÉ
getshortname
Gets short path form of a specified path (available on windows only. On
OS/2 performs a findfile).
shortname=getshortname(LongFilename)
LongFilename - long name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 18. getfullpathname ΓòÉΓòÉΓòÉ
getfullpathname
Returns current directory plus Filename .
fullname=getfullpathname(Filename)
Filename - name of file
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 19. getfilepart ΓòÉΓòÉΓòÉ
getfilepart
Returns Filename part of Fully Qualified path\name .
pathname=getfilepart(FilePathName)
FilePathName - Fully qualified path\name of file
Returns NULL string if the file does not exist
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 20. getdirpart ΓòÉΓòÉΓòÉ
getdirpart
Returns Directory part of Fully Qualified path\name .
pathdirectory=getdirpart(Filename)
Filename - name of file
Returns NULL string if the file does not exist
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 21. findfile ΓòÉΓòÉΓòÉ
findfile
Returns Fully Qualified path\name of File .
path=findfile(Filename)
Filename - name of file
If Filename includes a fully qualified directory path the function
checks if the file exists.
It returns NULL string if the file does not exist
If Filename does not includes a fully qualified directory path - i.e.
file name only
the function searches the system path directories for the file.
It returns NULL string if the file does not exist
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 22. getnolines ΓòÉΓòÉΓòÉ
getnolines
Returns number of lines in Filename .
nolines=getnolines(Filename[,"CSVFILE"])
Filename - name of file
"CSVFILE" - optional string "CSVFILE" to read CSV lines that contain
carriage/return line feeds
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 23. getlinepos ΓòÉΓòÉΓòÉ
getlinepos
Gets position of line LineNumber in file Filename .
position=getlinepos(Filename,LineNumber[,"CSVFILE"])
Filename - name of file
LineNumber - number of line to find position of
If Line number is negative it is the line number count is taken from the
end of the file
i.e. in a 20 line file Line Number -18 is the same as Line Number 3
"CSVFILE" - optional string "CSVFILE" to read CSV lines that contain
carriage/return line feeds
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 24. getline ΓòÉΓòÉΓòÉ
getline
Gets contents of line LineNumber in file Filename .
line=getline(Filename,LineNumber[,"CSVFILE"])
Filename - name of file
LineNumber - number of line to return
If Line number is negative it is the line number count is taken from the
end of the file
i.e. in a 20 line file Line Number -18 is the same as Line Number 3
"CSVFILE" - optional string "CSVFILE" to read CSV lines that contain
carriage/return line feeds
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 25. getlineatpos ΓòÉΓòÉΓòÉ
getlineatpos
Gets contents of line at position in file Filename .
line=getlineatpos(Filename,Position[,"CSVFILE"])
Filename - name of file
Position - position in the file of the start of the line
"CSVFILE" - optional string "CSVFILE" to read CSV lines that contain
carriage/return line feeds
returns
RESULT.LINENO line number
RESULT.LINEPOS position of the line
RESULT.NEXTLINEPOS position of the next line
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 26. getstring ΓòÉΓòÉΓòÉ
getstring
Gets String from Filename at Position.
string=getstring(Filename,Position,Length)
Filename - name of file
Position - position where the string starts
Length - length of the string
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 27. insertstring ΓòÉΓòÉΓòÉ
insertstring
Inserts String into Filename at Position .
f=insertstring(Filename,Position,String)
Filename - name of file
Position - position where the string is inserted
String - string to insert
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 28. insertstringcrlf ΓòÉΓòÉΓòÉ
insertstringcrlf
Inserts String into Filename at Position and adds a carriage-return
line-feed .
f=insertstringcrlf(Filename,Position,String)
Filename - name of file
Position - position where the string is inserted
String - string to insert
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 29. deletestring ΓòÉΓòÉΓòÉ
deletestring
Deletes Length characters at Position from Filename .
f=deletestring(Filename,Position,Length)
Filename - name of file
Position - position where to start deleting
Length - number of characters to delete
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 30. insertline ΓòÉΓòÉΓòÉ
insertline
Inset line into Filename at line LineNumber.
f=insertline(Filename,LineNumber,Line[,"CSVFILE"])
Filename - name of file
LineNumber - line number where the line is inserted
Line - line to insert
If Line number is negative it is the line number count is taken from the
end of the file
i.e. in a 20 line file Line Number -18 is the same as Line Number 3
"CSVFILE" - optional string "CSVFILE" to insert CSV lines that contain
carriage/return line feeds
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 31. deleteline ΓòÉΓòÉΓòÉ
deleteline
Delete line LineNumber from Filename.
f=deleteline(Filename,LineNumber[,"CSVFILE"])
Filename - name of file
LineNumber - line number to delete
If Line number is negative it is the line number count is taken from the
end of the file
i.e. in a 20 line file Line Number -18 is the same as Line Number 3
"CSVFILE" - optional string "CSVFILE" to delete CSV lines that contain
carriage/return line feeds
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 32. insertfile ΓòÉΓòÉΓòÉ
insertfile
Insert Filename at a given point.
f=insertfile(Filename,Position,FileToInsert)
Filename - name of file
Position - position where the FileToInsert must be inserted
FileToInsert - name of file to insert
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 33. newfilefromposition ΓòÉΓòÉΓòÉ
newfilefromposition
Creates new file NewFilename with data from Position.
f=newfilefromposition(Filename,StartPosition,EndPosition,NewFileName)
Filename - name of file
StartPosition - start position of the data - 1st char is at position 0
EndPosition - end position of the data - 1st char is at position 0
NewFileName - name of new file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 34. getnocsvcolumns ΓòÉΓòÉΓòÉ
getnocsvcolumns
Gets the number of columns in a CSV tab or comma delimited line.
nocols=getnocsvcolumns(Line)
Line - line from a CSV file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 35. getcsvcolumn ΓòÉΓòÉΓòÉ
getcsvcolumn
Gets the nth column entry from a CSV tab or comma delimited line.
column=getcsvcolumn(Line,ColumnNumber)
Line - line from a CSV file
ColumnNumber - column number starting at 1
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 36. replacecsvcolumn ΓòÉΓòÉΓòÉ
replacecsvcolumn
Replaces the nth column entry into a CSV tab or comma delimited line.
newline=replacecsvcolumn(Line,ColumnNumber,Column)
Line - line from a CSV file
ColumnNumber - column number starting at 1
Column - column data to replace existing comumn data
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 37. newtempfile ΓòÉΓòÉΓòÉ
newtempfile
Creates new temporary file.
tempfilename=newtempfile()
No Arguments
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 38. existfile ΓòÉΓòÉΓòÉ
existfile
Tests existance of a file.
f=existfile(Filename)
Filename - name of file
Returns NULL if the file does not exist, else returns the filename
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 39. renamefile ΓòÉΓòÉΓòÉ
renamefile
Rename a file.
f=renamefile(OldFilename,NewFilename)
OldFilename - old name of the file
NewFilename - new name of the file - filename only - no path
Returns NULL if the file does not exist, else returns the new filename
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 40. addquotestoline ΓòÉΓòÉΓòÉ
addquotestoline
Add quotes to each end of a line of text.
NewLine=addquotestoline(Line)
Line - line of text
If the text contains a double quote ("), single quotes (') are added to
the line, otherwise doublequotes are used.
e.g.
Hello becomes "Hello"
Hello" becomes 'Hello"'
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 41. addsinglequotestoline ΓòÉΓòÉΓòÉ
addsinglequotestoline
Add single quotes to each end of a line of text and double up and single
quotes within the line.
NewLine=addsinglequotestoline(Line)
Line - line of text
Singlequotes are used.
e.g.
Hello becomes 'Hello'
Fred's car becomes 'Fred''s car'
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 42. adddoublequotestoline ΓòÉΓòÉΓòÉ
adddoublequotestoline
Add double quotes to each end of a line of text and double up and double
quotes within the line.
NewLine=adddoublequotestoline(Line)
Line - line of text
Doublequotes are used.
e.g.
Hello becomes "Hello"
He said "Hello" loudly becomes "He said ""Hello"" loudly"'
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 43. stripquotesfromline ΓòÉΓòÉΓòÉ
stripquotesfromline
Strips quotes from each end of a line of text.
NewLine=stripquotesfromline(Line[,"REMEXTRAQUOTES"])
Line - line of text
REMEXTRAQUOTES - optional - two adjacent quotes (same as end quotes)
within the line are replaced by a single quote
The line must start and end with either single quotes (') or must start
and end with double quotes (").
e.g.
"Hello" becomes Hello
'Hello' becomes Hello
using the "REMEXTRAQUOTES" option -
"Hello ""John""." becomes Hello "John".
'John''s car' becomes John's car
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 44. getkeyfromcsvfilecol ΓòÉΓòÉΓòÉ
getkeyfromcsvfilecol
Gets unique key from column in CSV file.
Key=getkeyfromcsvfilecol(Filename,ColumnNo)
Filename - name of file
ColumnNo - no of column (1 first column, 2 second column ... etc)
Line - line of text
File Filename must contain CSV tab or comma delimited lines.
Key is a unique number that does not appear in the existing column and
can safely be inserted as an entry in column ColumnNo in a new line,
leaving all entries in the column unique.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 45. readfiletostem ΓòÉΓòÉΓòÉ
readfiletostem
Reads a file into a stem variable.
f=readfiletostem(Filename,StemVariable[,FileStartLine,FileEndLine])
Filename - name of file
StemVariable - name of stem variable to read the file into
FileStartLine - start at line FileStartLine of the file (Default whole
file)
FileEndLine - end at line FileEndLine of the file
STEM.0 - number of stem entries (lines in the file)
STEM.i - line i of the file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 46. insertfilefromstem ΓòÉΓòÉΓòÉ
insertfilefromstem
Inserts lines into a file from a stem variable.
f=insertfilefromstem(Filename,StemVariable[,FileStartLine,StemStartPosition,StemEndPosition])
Filename - name of file
StemVariable - name of stem variable that contains the file to be
written
FileStartLine - start writing the file from line FileStartLine (Default
1)
StemStartPosition - Stem.StemStartPosition is the first line written
(Default whole file)
StemEndPosition - Stem.StemEndPosition is the last line written
STEM.0 - number of stem entries (lines in the file)
STEM.i - line i of the file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 47. inusefile ΓòÉΓòÉΓòÉ
inusefile
Tests whether a file is is use.
f=inusefile(Filename)
Filename - name of file
Returns NULL if the file does not exist, else returns 1 if the file is
in use, 0 if not in use.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 48. getcharatpos ΓòÉΓòÉΓòÉ
getcharatpos
Gets character at position in file Filename .
char=getcharatpos(Filename,Position)
Filename - name of file
Position - position in the file
returns character at the position, NULL string returned if position
invalid.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 49. getwordatpos ΓòÉΓòÉΓòÉ
getwordatpos
Gets word at position in file Filename .
word=getwordatpos(Filename,Position)
Filename - name of file
Position - position in the file
returns word at the position, NULL string returned if position invalid
or no valid word at the position
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 50. fixlinefeeds ΓòÉΓòÉΓòÉ
fixlinefeeds
Replaces single line feeds with carriage return line feed .
f=fixlinefeeds(Filename)
Filename - name of file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 51. fixlinefeedsrememptylines ΓòÉΓòÉΓòÉ
fixlinefeedsrememptylines
Replaces single line feeds with carriage return line feed and removes
empty lines.
f=fixlinefeedsrememptylines(Filename)
Filename - name of file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 52. getfilereplacetext ΓòÉΓòÉΓòÉ
getfilereplacetext
Replace all occurences of one string with another (available on windows
only).
f=getfilereplacetext(Filename,OldString,NewString)
Filename - name of file.
OldString - string to replace.
NewString - new string.
Returns
All the text in FileName with OldString is replaced by NewString.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 53. importfilestofile ΓòÉΓòÉΓòÉ
importfilestofile
Imports a list of files into one file.
f=importfilestofile(Filename,StemVariable)
Filename - name of file containing all the files.
StemVariable - name of stem variable that contains the files to be
written
STEM.0 - number of stem entries (n = number of files)
STEM.1 - name of file 1
STEM.EXPORT.1 - export name of file - default is name of file 1
STEM.2 - name of file 2
STEM.EXPORT.2 - export name of file - default is name of file 2
...
STEM.n - name of file n
STEM.EXPORT.n - export name of file - default is name of file n
In windows the files listed in StemVariable may be compressed files.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 54. exportfilesfromfile ΓòÉΓòÉΓòÉ
exportfilesfromfile
Exports a list of files from one file.
f=exportfilesfromfile(Filename)
Filename - name of file containing all the files (in windows this file
may be a compressed file).
If the fully qualified pathname was not provided when the files were
imported to FileName, files are exported to the current directory.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 55. delexpfilesfromfile ΓòÉΓòÉΓòÉ
delexpfilesfromfile
Deletes a list of files previously exported from one file
f=delexpfilesfromfile(Filename)
Filename - name of file containing all the files (in windows this file
may be a compressed file).
If the fully qualified pathname was not provided when the files were
imported to FileName, files are deleted in the current directory.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 56. createsetupexe ΓòÉΓòÉΓòÉ
createsetupexe
Create a setup executable file (available on windows only).
f=createsetupexe(ImportedFile,SubdirectoryName[,ExeToRunName[,DeleteOption[,SetupExeName]]])
ImportedFile - file created using the importfilestofile function
SubdirectoryName - name of sub-directory which will contain the
expanded setup files
ExeToRunName - optional - name of executable file to run after the
files have been expanded - can be NULL "" if no executable is to be run -
default NULL ""
DeleteOption - optional - "DELETE" string - if specified expanded files
are deleted after ExeToRunName is run - default NULL "" files are not
deleted
SetupExeName - name of setup executable files - default "Setup.exe"
The executable file created requires REXXIO and a licensed copy of
"Modular And Integrated Design" to be installed.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 57. readfiletovariable ΓòÉΓòÉΓòÉ
readfiletovariable
Reads a file to a rexx variable.
f=readfiletovariable(Filename,Variablename)
Filename - file to read
Variablename - name of variable
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 58. openfile ΓòÉΓòÉΓòÉ
openfile
Open file.
filehandle=openfile(Filename,FileAccess,ShareMode,Creation)
Filename - file to open
FileAccess - File Access - can be "READ" , "WRITE" , or "READWRITE"
ShareMode - Share Mode - can be "SHARENONE" , "SHAREREAD" ,
"SHAREWRITE"
or "SHAREREADWRITE"
Creation - Creation attributes - can be "CREATENEW" , "CREATEALWAYS" ,
"OPENEXISTING" , "OPENALWAYS" or "TRUNCATEEXISTING"
A filehandle of -1 is returned if the file is not opened.
"CREATENEW" returns -1 if the file already exists
"CREATEALWAYS" overwrites the file if it exists
"OPENEXISTING" returns -1 if the file does not exist
"OPENALWAYS" does a "CREATENEW" if the file does not exist
"TRUNCATEEXISTING" returns -1 if the file does not exist
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 59. closefile ΓòÉΓòÉΓòÉ
closefile
Close file.
f=close(filehandle)
filehandle - file handle returned by openfile
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 60. setfilepointer ΓòÉΓòÉΓòÉ
setfilepointer
Positions a file pointer within a file.
f=setfilepointer(filehandle,position[,anchorposition])
filehandle - file handle returned by openfile
position - offset from the anchorposition - positive from the beginning
and negative from the end
anchorposition - optional - "BEGIN" , "CURRENT" or "END" - default
"BEGIN"
"BEGIN" gives an offset position from the beginning of the file
"CURRENT" gives an offset position from the current position
"END" gives an offset position from the end of the file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 61. readfile ΓòÉΓòÉΓòÉ
readfile
Reads from an open file.
string=readfile(filehandle,noofchars)
filehandle - file handle returned by openfile
noofchars - no of characters to read
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 62. writefile ΓòÉΓòÉΓòÉ
writefile
Writes to an open file..
f=writefile(filehandle,string)
filehandle - file handle returned by openfile
string - string to write
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 63. setendoffile ΓòÉΓòÉΓòÉ
setendoffile
Writes an EOF marker to the file.
f=setendoffile(filehandle)
filehandle - file handle returned by openfile
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 64. emptyfile ΓòÉΓòÉΓòÉ
emptyfile
Deletes the contents of a file.
f=emptyfile(filehandle)
filehandle - file handle returned by openfile
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 65. copytoclipboardfromfile ΓòÉΓòÉΓòÉ
copytoclipboardfromfile
Copy to clipboard from file. (available on windows only)
f=copytoclipboardfromfile(Filename[,Type])
Filename - file to copy from
Type - optional - default "TEXT"
can be one of -
"TEXT" - Text Format
"RTF" - Rich Text Format
"RTFNOOBJECTS" - Rich Text Format Without Objects
"RTFOBJECTS" - RichEdit Text and Objects
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 66. copytoclipboardfrommle ΓòÉΓòÉΓòÉ
copytoclipboardfrommle
Copy to clipboard from mle. (available on windows only)
f=copytoclipboardfrommle(Hwnd[,Type])
Hwnd - window handle of the MLE
Type - optional - default "TEXT"
can be one of -
"TEXT" - Text Format
"RTF" - Rich Text Format
"RTFNOOBJECTS" - Rich Text Format Without Objects
"RTFOBJECTS" - RichEdit Text and Objects
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 67. pastetomlefromfile ΓòÉΓòÉΓòÉ
pastetomlefromfile
Paste to mle from file. (available on windows only)
f=pastetomlefromfile(Hwnd,Filename[,Type])
Hwnd - window handle of the MLE
Filename - file to copy from
Type - optional - default "TEXT"
can be one of -
"TEXT" - Text Format
"RTF" - Rich Text Format
"RTFNOOBJECTS" - Rich Text Format Without Objects
"RTFOBJECTS" - RichEdit Text and Objects
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 68. pastetomlefromclipboard ΓòÉΓòÉΓòÉ
pastetomlefromclipboard
Paste to mle from clipboard. (available on windows only)
f=pastetomlefromclipboard(Hwnd[,Type])
Hwnd - window handle of the MLE
Type - optional - default "TEXT"
can be one of -
"TEXT" - Text Format
"RTF" - Rich Text Format
"RTFNOOBJECTS" - Rich Text Format Without Objects
"RTFOBJECTS" - RichEdit Text and Objects
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 69. pastetofilefrommle ΓòÉΓòÉΓòÉ
pastetofilefrommle
Paste to file from mle. (available on windows only)
f=pastetofilefrommle(Hwnd,Filename[,Type])
Hwnd - window handle of the MLE
Filename - file to copy from
Type - optional - default "TEXT"
can be one of -
"TEXT" - Text Format
"RTF" - Rich Text Format
"RTFNOOBJECTS" - Rich Text Format Without Objects
"RTFOBJECTS" - RichEdit Text and Objects
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 70. pastetofilefromclipboard ΓòÉΓòÉΓòÉ
pastetofilefromclipboard
Paste to file from clipboard. (available on windows only)
f=pastetofilefromclipboard(Filename[,Type])
Filename - file to copy from
Type - optional - default "TEXT"
can be one of -
"TEXT" - Text Format
"RTF" - Rich Text Format
"RTFNOOBJECTS" - Rich Text Format Without Objects
"RTFOBJECTS" - RichEdit Text and Objects
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 71. changemleselectedcharformat ΓòÉΓòÉΓòÉ
changemleselectedcharformat
Change mle selected character format.. (available on windows only)
f=changemleselectedcharformat(Hwnd,Red,Green,Blue[,SelType[,Font]])
Hwnd - window handle of the MLE
Red - red component of color can be in range 0 to 255
Green - green component of color can be in range 0 to 255
Blue - blue component of color can be in range 0 to 255
SelType - optional - selection type default "SELECTION"
can be one of -
"SELECTION" - Text in selected area is changed
"WORD" - Word selected is changed
Font - optional - Font type and style and size default "" - no change
eg - format FaceName.Family.Style.Size
example "Times New Roman.Italic.14"
FaceName - name of font eg "Times New Roman" "Ariel"
Family - "Modern" - "Roman" - "Script" - "Helv" - "System" -
"Decorative"
Style - "Italic" - "Underscore" - "Strikeout" - "Bold"- "Heavy" (same as
"Bold")
Size - point size
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 01 File Functions.
ΓòÉΓòÉΓòÉ 72. Section 02 Directory Functions ΓòÉΓòÉΓòÉ
Section 02 - Directory Functions
cd Changes current directory to NewDirectory.
md Creates directory NewDirectory.
rd Removes Directory.
dirfile Creates File containing info on Directory\Pattern.
dirstem Creates StemVariable containing file info on
Directory\Pattern.
dirfiledir Creates File containing directory file info on
Directory\Pattern.
dirstemdir Creates StemVariable containing directory info on
Directory\Pattern.
getshellfolders Gets all Shell Folders into StemVariable.
gettempdir Gets Temp Directory Pathname
getcurrentdir Gets current directory.
getdesktopdir Gets directory for desktop.
getdrives Gets list of logical drives into a Stem Variable.
existdir* Tests existance of a directory.
Contents.
ΓòÉΓòÉΓòÉ 73. cd ΓòÉΓòÉΓòÉ
cd
Changes current directory to Directory .
f=cd(Directory)
Directory - name of directory
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 74. md ΓòÉΓòÉΓòÉ
md
Creates directory NewDirectory .
f=md(NewDirectory)
NewDirectory - name of new directory
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 75. rd ΓòÉΓòÉΓòÉ
rd
Removes Directory .
f=rd(Directory)
Directory - name of directory
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 76. dirfile ΓòÉΓòÉΓòÉ
dirfile
Creates StemVariable containing file info on Directory .
f=dirfile(Directory[ /s],Filename[ +])
Directory - name of directory with optional wild card characters (* and
?) - append string ' /s' to include sub-directories
Filename - name of file to place results in
[ +] - optional ' +' at end of the filename appends results to the
file , otherwise a new file is created.
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 77. dirstem ΓòÉΓòÉΓòÉ
dirstem
Creates StemVariable containing file info on Directory .
f=dirstem(Directory[ /s],StemVariable)
Directory - name of directory with optional wild card characters (* and
?) - append string ' /s' to include sub-directories
StemVariable - name of Stem Variable to place results in
For files
STEM.DIR directory being searched
STEM.0 - number of file entries
STEM.CREATIONTIME.i - Creation time for file i
STEM.LASTACCESSTIME.i - Last access time for file i
STEM.LASTWRITETIME.i - Last write time for file i
STEM.NAME.i - Name of file i
STEM.SHORTNAME.i - Short name of file i
STEM.SIZE.i - Size of file i
STEM.SIZEHIGH.i - Size High of file i
Examples -
f=dirstem("C:\MAID","STEM1")
say STEM1.DIR
do i=1 to STEM1.0
say STEM1.CREATIONTIME.i
say STEM1.LASTACCESSTIME.i
say STEM1.LASTWRITETIME.i
say STEM1.NAME.i
say STEM1.SHORTNAME.i
say STEM1.SIZE.i
say STEM1.SIZEHIGH.i
end
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 78. dirfiledir ΓòÉΓòÉΓòÉ
dirfiledir
Creates StemVariable containing directory info on Directory .
f=dirfiledir(Directory[ /s],Filename[ +])
Directory - name of directory with optional wild card characters (* and
?) - append string ' /s' to include sub-directories
Filename - name of file to place results in
[ +] - optional ' +' at end of the filename appends results to the
file , otherwise a new file is created.
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 79. dirstemdir ΓòÉΓòÉΓòÉ
dirstemdir
Creates StemVariable containing directory info on Directory .
f=dirstemdir(Directory[ /s],StemVariable)
Directory - name of directory with optional wild card characters (* and
?) - append string ' /s' to include sub-directories
StemVariable - name of Stem Variable to place results in
STEM.DIR directory being searched
STEM.DIR.0 number of directory entries
STEM.DIR.CREATIONTIME.i - Creation time for directory i
STEM.DIR.LASTACCESSTIME.i - Last access time for directory i
STEM.DIR.LASTWRITETIME.i - Last write time for directory i
STEM.DIR.NAME.i - Name of directory i
STEM.DIR.SHORTNAME.i - Short name of directory i
STEM.DIR.SIZE.i - Size of directory i
STEM.DIR.SIZEHIGH.i - Size High of directory i
Examples -
f=dirstem("C:\MAID","STEM1")
say STEM1.DIR
do i=1 to STEM1.DIR.0
say STEM1.DIR.CREATIONTIME.i
say STEM1.DIR.LASTACCESSTIME.i
say STEM1.DIR.LASTWRITETIME.i
say STEM1.DIR.NAME.i
say STEM1.DIR.SHORTNAME.i
say STEM1.DIR.SIZE.i
say STEM1.DIR.SIZEHIGH.i
end
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 80. getshellfolders ΓòÉΓòÉΓòÉ
getshellfolders
Gets all Shell Folders into StemVariable .
f=getshellfolders(StemVariable)
StemVariable - name Stem Variable to place results in
STEM.0 number of folder entries
STEM.FOLDER.i - Folder Name i
STEM.DIR.i - Folder Directory i
Folders are listed from entries in the key
HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\Shell
Folders
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 81. gettempdir ΓòÉΓòÉΓòÉ
gettempdir
Gets Temp Directory Pathname .
temppath=gettempdir()
No Arguments
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 82. getcurrentdir ΓòÉΓòÉΓòÉ
getcurrentdir
Gets current directory
currentdir=getcurrentdir()
No Arguments
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 83. getdesktopdir ΓòÉΓòÉΓòÉ
getdesktopdir
Gets directory for desktop
desktopdir=getdesktopdir()
No Arguments
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 84. getdrives ΓòÉΓòÉΓòÉ
getdrives
Gets list of logical drives into a Stem Variable
f=getdrives(StemVariable)
StemVariable - name Stem Variable to place results in
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 85. existdir ΓòÉΓòÉΓòÉ
existdir
Tests existance of a directory.
f=existdir(Directory)
Directory - name of directory
Returns NULL if the directory does not exist, else returns the directory
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 02 Directory Functions.
ΓòÉΓòÉΓòÉ 86. Section 03 Search Functions ΓòÉΓòÉΓòÉ
Section 03 - Search Functions
searchcaseon Makes string searches in findstring case sensitive.
searchcaseoff Makes string searches in findstring non case sensitive.
findstringtofile Seaches All files matching FilenamePattern for
SearchString to Filename.
findstringtostem Seaches All files matching FilenamePattern for
SearchString to Stem Variable.
changestring Replaces ReplaceString with NewString according to
StringInfo.
filenamefrominfo* Gets filename from StringInfo.
startposfrominfo* Gets start position from StringInfo.
endposfrominfo* Gets end position from StringInfo.
Contents.
ΓòÉΓòÉΓòÉ 87. searchcaseon ΓòÉΓòÉΓòÉ
searchcaseon
Makes string searches in findstring case sensitive .
f=searchcaseon()
No Arguments
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 88. searchcaseoff ΓòÉΓòÉΓòÉ
searchcaseoff
Makes string searches in findstring non case sensitive .
f=searchcaseoff()
No Arguments
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 89. findstringtofile ΓòÉΓòÉΓòÉ
findstringtofile
Searches All files matching FilenamePattern for SearchString up to Count
times per file. If Count left out all occurrences found. Results in
Filename .
The following are character sequences that represent special keys -
{SHIFT} {CONTROL} {ALT} {LSHIFT} {RSHIFT} {LCONTROL} {RCONTROL} {LALT}
{RALT}
{LBUTTON} {RBUTTON} {CANCEL} {MBUTTON} {BACK} {TAB} {CLEAR} {PAUSE}
{RETURN} {CR} {LINEFEED} {LF}
{CAPITAL} {ESCAPE} {SPACE} {PRIOR} {NEXT} {END} {HOME} {LEFT} {UP}
{RIGHT} {DOWN}
{SELECT} {PRINT} {EXECUTE} {SNAPSHOT} {INSERT} {DELETE} {HELP} {LWIN}
{RWIN} {APPS}
{NUMPAD0} {NUMPAD1} {NUMPAD2} {NUMPAD3} {NUMPAD4} {NUMPAD5} {NUMPAD6}
{NUMPAD7}
{NUMPAD8} {NUMPAD9} {MULTIPLY} {ADD} {SEPARATOR} {SUBTRACT} {DECIMAL}
{DIVIDE}
{F1} {F2} {F3} {F4} {F5} {F6} {F7} {F8} {F9} {F10} {F11} {F12} {F13}
{F14} {F15}
{F16} {F17} {F18} {F19} {F20} {F21} {F22} {F23} {F24}
{NUMLOCK} {SCROLL} {PROCESSKEY} {ATTN} {CRSEL} {EXSEL} {EREOF} {PLAY}
{ZOOM} {NONAME} {PA1} {OEM_CLEAR} .
{{} represents the { character
{}} represents the } charter
"" represents the " character
{r,n} where n and r are integers - repeats the next n characters r times
To search for multiple characters place '{r[,n]}' before the character
where r is the number of repeats
and n is an optional number of characters to repeat - default for n is
1.
i.e.
{4}{SPACE} will search for 4 spaces
{5,2}{CR}{LF} will search for 5 carriage-return line-feeds.
{...} represents any text between two search patterns
{...Char1-Char2} represents any text between two search patterns with
chars in the range Char1 to Char2
i.e. {...A-Z} represents a string of any length of upper case alpha
characters
{...!Char1-Char2} represents any text between two search patterns with
chars NOT in the range Char1 to Char2
i.e. {...!A-Z} represents a string of any length that does not contain
upper case alpha characters
{...Char} represents any text between two search patterns consisting
entirely of the character Char
i.e. {...A} represents a string of any length consisting entirely of the
character A
{...!Char} represents any text between two search patterns that does not
contain the character Char
i.e. {...!A} represents a string of any length that does not contain the
character A
{...CharString} represents any text between two search patterns with
chars in the string CharString
i.e. {...who} represents a string of any length that contains only the
characters 'w' or 'h' or 'o'
{...!CharString} represents any text between two search patterns with
chars that are not in the string CharString
i.e. {...!who} represents a string of any length that does not contain
the characters 'w' or 'h' or 'o'
NULLS are replaced with spaces to allow for text searches in binary
files.
f=findstringtofile(SearchString,Directory[ /s],Filename[
+][,StartPos,EndPos][,Count])
SearchString - string to search for - concatenate {EOF} to the string
to find a match at the end of the file
Directory - name of directory with optional wild card characters (* and
?) - append string ' /s' to include sub-directories. Can also be a
Filename
Filename - name of file containing the results
[ +] - optional ' +' at end of the filename appends results to the
file , otherwise a new file is created.
StartPos* EndPos* - optional start/end position for search - both
options must be given - default start of file/end of file - an EndPos of
0 indicates end of file - (option requires a licensed copy of "Modular
And Integrated Design" to be installed)
Count - optional count to limit the number of occurrences found
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 90. findstringtostem ΓòÉΓòÉΓòÉ
findstringtostem
Searches All files matching FilenamePattern for SearchString up to Count
times per file. If Count left out all occurrences found. Results in Stem
Variable .
The following are character sequences that represent special keys -
{SHIFT} {CONTROL} {ALT} {LSHIFT} {RSHIFT} {LCONTROL} {RCONTROL} {LALT}
{RALT}
{LBUTTON} {RBUTTON} {CANCEL} {MBUTTON} {BACK} {TAB} {CLEAR} {PAUSE}
{RETURN} {CR} {LINEFEED} {LF}
{CAPITAL} {ESCAPE} {SPACE} {PRIOR} {NEXT} {END} {HOME} {LEFT} {UP}
{RIGHT} {DOWN}
{SELECT} {PRINT} {EXECUTE} {SNAPSHOT} {INSERT} {DELETE} {HELP} {LWIN}
{RWIN} {APPS}
{NUMPAD0} {NUMPAD1} {NUMPAD2} {NUMPAD3} {NUMPAD4} {NUMPAD5} {NUMPAD6}
{NUMPAD7}
{NUMPAD8} {NUMPAD9} {MULTIPLY} {ADD} {SEPARATOR} {SUBTRACT} {DECIMAL}
{DIVIDE}
{F1} {F2} {F3} {F4} {F5} {F6} {F7} {F8} {F9} {F10} {F11} {F12} {F13}
{F14} {F15}
{F16} {F17} {F18} {F19} {F20} {F21} {F22} {F23} {F24}
{NUMLOCK} {SCROLL} {PROCESSKEY} {ATTN} {CRSEL} {EXSEL} {EREOF} {PLAY}
{ZOOM} {NONAME} {PA1} {OEM_CLEAR} .
{{} represents the { character
{}} represents the } character
"" represents the " character
{r,n} where n and r are integers - repeats the next n characters r times
To search for multiple characters place '{r[,n]}' before the character
where r is the number of repeats
and n is an optional number of characters to repeat - default for n is
1.
i.e.
{4}{SPACE} will search for 4 spaces
{5,2}{CR}{LF} will search for 5 carriage-return line-feeds.
{...} represents any text between two search patterns
{...Char1-Char2} represents any text between two search patterns with
chars in the range Char1 to Char2
i.e. {...A-Z} represents a string of any length of upper case alpha
characters
{...!Char1-Char2} represents any text between two search patterns with
chars NOT in the range Char1 to Char2
i.e. {...!A-Z} represents a string of any length that does not contain
upper case alpha characters
{...Char} represents any text between two search patterns consisting
entirely of the character Char
i.e. {...A} represents a string of any length consisting entirely of the
character A
{...!Char} represents any text between two search patterns that does not
contain the character Char
i.e. {...!A} represents a string of any length that does not contain the
character A
{...CharString} represents any text between two search patterns with
chars in the string CharString
i.e. {...who} represents a string of any length that contains only the
characters 'w' or 'h' or 'o'
{...!CharString} represents any text between two search patterns with
chars that are not in the string CharString
i.e. {...!who} represents a string of any length that does not contain
the characters 'w' or 'h' or 'o'
NULLS are replaced with spaces to allow for text searches in binary
files.
f=findstringtostem(SearchString,Directory[
/s],StemVariable[,StartPos,EndPos][,Count])
SearchString - string to search for - concatenate {EOF} to the string
to find a match at the end of the file
Directory - name of directory with optional wild card characters (* and
?) - append string ' /s' to include sub-directories
StemVariable - name of stem variable containing the results
StemVariable.0 number of results
StemVariable.1 first result
. . .
StemVariable.N Nth result
StartPos* EndPos* - optional start/end position for search - both
options must be given - default start of file/end of file - an EndPos of
0 indicates end of file - (option requires a licensed copy of "Modular
And Integrated Design" to be installed)
Count - optional count to limit the number of occurrences found
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 91. changestring ΓòÉΓòÉΓòÉ
changestring
Replaces ReplaceString with NewString according to StringInfo.
StringInfo is a line of find information returned by findstringtofile or
findstringtostem .
The following are character sequences that represent special keys -
{SHIFT} {CONTROL} {ALT} {LSHIFT} {RSHIFT} {LCONTROL} {RCONTROL} {LALT}
{RALT}
{LBUTTON} {RBUTTON} {CANCEL} {MBUTTON} {BACK} {TAB} {CLEAR} {PAUSE}
{RETURN} {CR} {LINEFEED} {LF}
{CAPITAL} {ESCAPE} {SPACE} {PRIOR} {NEXT} {END} {HOME} {LEFT} {UP}
{RIGHT} {DOWN}
{SELECT} {PRINT} {EXECUTE} {SNAPSHOT} {INSERT} {DELETE} {HELP} {LWIN}
{RWIN} {APPS}
{NUMPAD0} {NUMPAD1} {NUMPAD2} {NUMPAD3} {NUMPAD4} {NUMPAD5} {NUMPAD6}
{NUMPAD7}
{NUMPAD8} {NUMPAD9} {MULTIPLY} {ADD} {SEPARATOR} {SUBTRACT} {DECIMAL}
{DIVIDE}
{F1} {F2} {F3} {F4} {F5} {F6} {F7} {F8} {F9} {F10} {F11} {F12} {F13}
{F14} {F15}
{F16} {F17} {F18} {F19} {F20} {F21} {F22} {F23} {F24}
{NUMLOCK} {SCROLL} {PROCESSKEY} {ATTN} {CRSEL} {EXSEL} {EREOF} {PLAY}
{ZOOM} {NONAME} {PA1} {OEM_CLEAR} .
{{} represents the { character
{}} represents the } character
"" represents the " character
{r,n} where n and r are integers - repeats the next n characters r times
To search for multiple characters place '{r[,n]}' before the character
where r is the number of repeats
and n is an optional number of characters to repeat - default for n is
1.
i.e.
{4}{SPACE} will search for 4 spaces
{5,2}{CR}{LF} will search for 5 carriage-return line-feeds.
{...} represents any text between two search patterns
{...Char1-Char2} represents any text between two search patterns with
chars in the range Char1 to Char2
i.e. {...A-Z} represents a string of any length of upper case alpha
characters
{...!Char1-Char2} represents any text between two search patterns with
chars NOT in the range Char1 to Char2
i.e. {...!A-Z} represents a string of any length that does not contain
upper case alpha characters
{...Char} represents any text between two search patterns consisting
entirely of the character Char
i.e. {...A} represents a string of any length consisting entirely of the
character A
{...!Char} represents any text between two search patterns that does not
contain the character Char
i.e. {...!A} represents a string of any length that does not contain the
character A
{...CharString} represents any text between two search patterns with
chars in the string CharString
i.e. {...who} represents a string of any length that contains only the
characters 'w' or 'h' or 'o'
{...!CharString} represents any text between two search patterns with
chars that are not in the string CharString
i.e. {...!who} represents a string of any length that does not contain
the characters 'w' or 'h' or 'o'
f=changestring(StringInfo,ReplaceString,NewString[,OffsetVariable])
StringInfo - line of information from findstringtofile or
findstringtostem
ReplaceString - string to replace - pass an empty string ("") to
replace the entire string defined in StringInfo
NewString - new string to replace replacestring - {...} and
{...Char1-Char2} are ignored and have no meaning in NewString
OffsetVariable - optional - name of offset variable which contains an
offset - adds this offset to the replace string position before doing the
change - after the change this offset is updated to reflect the new
change
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 92. filenamefrominfo ΓòÉΓòÉΓòÉ
filenamefrominfo
Gets start position from StringInfo.
FileName=filenamefrominfo(StringInfo)
StringInfo - line of information from findstringtofile or
findstringtostem
FileName - filename in stringinfo - returns -1 if not found
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 93. startposfrominfo ΓòÉΓòÉΓòÉ
startposfrominfo
Gets start position from StringInfo.
StartPos=startposfrominfo(StringInfo)
StringInfo - line of information from findstringtofile or
findstringtostem
StartPos - start position in stringinfo - returns -1 if not found
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 94. endposfrominfo ΓòÉΓòÉΓòÉ
endposfrominfo
Gets start position from StringInfo.
EndPos=endposfrominfo(StringInfo)
StringInfo - line of information from findstringtofile or
findstringtostem
EndPos - end position in stringinfo - returns -1 if not found
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 03 Search Functions.
ΓòÉΓòÉΓòÉ 95. Section 04 Windows Functions ΓòÉΓòÉΓòÉ
Section 04 - Window Functions
toplevelwindowlist List all Top Level Windows in Stem Variable.
getwindow Return handle of window with title.
getwindowwithchild* Return handle of window with title that contains
child with text.
sendwindowtext Send text to window.
sendwindowfile* Send contents of file to window.
setwindowpos Set window position.
getwindowpos Get window position.
setwindowtopmost* Place window above all non-topmost windows.
setwindownormal* Place window above all non-topmost windows ,behind
all topmost windows.
setwindowbottom* Place window at bottom of Z order.
getforegroundwindow* Get window in the foreground.
setforegroundwindow* Place window in the foreground.
getwindowtitle* Get window title.
setwindowtitle* Set window title.
getwindowvariable* Get contents of a window to a variable.
getwindowfile* Get contents of a window to a file.
Contents.
ΓòÉΓòÉΓòÉ 96. toplevelwindowlist ΓòÉΓòÉΓòÉ
toplevelwindowlist
List all Top Level Windows in StemVariable
f=toplevelwindowlist(StemVariable)
StemVariable.0 number of windows N
StemVariable.TITLE.1 title of first window
StemVariable.HWND.1 window handle of first window
. . .
StemVariable.TITLE.N title of Nth window
StemVariable.HWND.N window handle of Nth window .
StemVariable - name Stem Variable to place results in
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 97. getwindow ΓòÉΓòÉΓòÉ
getwindow
Return handle of window with title.
hwnd=getwindow(Title[,ChildText])
Title - title of window to find
ChildText - text of child window to find
hwnd - window handle of window, 0 if window does not exist
Title - Title of the Window
ChildText - If ChildText (optional) is passed the child window handle of
the window containing "ChildText" in the window with title set
to "Title" is passed back
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 98. getwindowwithchild ΓòÉΓòÉΓòÉ
getwindowwithchild
Return handle of window with title that contains child with text .
hwnd=getwindowwithchild(Title,ChildText)
Title - title of window to find
ChildText - text of child window
hwnd - window handle of window, 0 if window does not exist
Title - Title of the Window
ChildText - Text of child window
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 99. sendwindowtext ΓòÉΓòÉΓòÉ
sendwindowtext
Send text to window.
f=sendwindowtext(hwnd,Text)
hwnd - window handle returned by getwindow
Text - text to send to the window
text can contain the following special character sequences - as in
getwindow .
The following are character sequences that represent special keys -
{SHIFT} {CONTROL} {ALT} {LSHIFT} {RSHIFT} {LCONTROL} {RCONTROL} {LALT}
{RALT}
{LBUTTON} {RBUTTON} {CANCEL} {MBUTTON} {BACK} {TAB} {CLEAR} {PAUSE}
{RETURN} {CR} {LINEFEED} {LF}
{CAPITAL} {ESCAPE} {SPACE} {PRIOR} {NEXT} {END} {HOME} {LEFT} {UP}
{RIGHT} {DOWN}
{SELECT} {PRINT} {EXECUTE} {SNAPSHOT} {INSERT} {DELETE} {HELP} {LWIN}
{RWIN} {APPS}
{NUMPAD0} {NUMPAD1} {NUMPAD2} {NUMPAD3} {NUMPAD4} {NUMPAD5} {NUMPAD6}
{NUMPAD7}
{NUMPAD8} {NUMPAD9} {MULTIPLY} {ADD} {SEPARATOR} {SUBTRACT} {DECIMAL}
{DIVIDE}
{F1} {F2} {F3} {F4} {F5} {F6} {F7} {F8} {F9} {F10} {F11} {F12} {F13}
{F14} {F15}
{F16} {F17} {F18} {F19} {F20} {F21} {F22} {F23} {F24}
{NUMLOCK} {SCROLL} {PROCESSKEY} {ATTN} {CRSEL} {EXSEL} {EREOF} {PLAY}
{ZOOM} {NONAME} {PA1} {OEM_CLEAR} .
{{} represents the { character
{}} represents the } character
"" represents the " character
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 100. sendwindowfile ΓòÉΓòÉΓòÉ
sendwindowfile
Send contents of file to window.
f=sendwindowtext(hwnd,Filename)
hwnd - window handle returned by getwindow
Filename - name of file whose contents will be place in the window.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 101. setwindowpos ΓòÉΓòÉΓòÉ
setwindowpos
Sets window position.
stemvariable.X - position of top left corner
stemvariable.Y - position of top left corner
stemvariable.CX - width
stemvariable.CY - height
stemvariable.SHOW - "MAXIMIZED" or "MINIMIZED" or "NORMAL" or "HIDDEN"
f=setwindowpos(hwnd,StemVariable)
hwnd - window handle returned by getwindow
StemVariable - name Stem Variable to get placement information
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 102. getwindowpos ΓòÉΓòÉΓòÉ
getwindowpos
Gets window position.
stemvariable.X - position of top left corner
stemvariable.Y - position of top left corner
stemvariable.CX - width
stemvariable.CY - height
stemvariable.SHOW - "MAXIMIZED" or "MINIMIZED" or "NORMAL" or "HIDDEN"
f=getwindowpos(hwnd,StemVariable)
hwnd - window handle returned by getwindow
StemVariable - name Stem Variable to place results in
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 103. setwindowtopmost ΓòÉΓòÉΓòÉ
setwindowtopmost
Place window above all non-topmost windows (available on windows only).
f=setwindowtopmost(hwnd[,Title])
hwnd - window handle returned by getwindow (can be NULL "" if a Title
is given)
Title - optional title of window - if given hwnd is ignored
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 104. setwindownormal ΓòÉΓòÉΓòÉ
setwindownormal
Place window above all non-topmost windows ,behind all topmost windows
(available on windows only) .
f=setwindownormal(hwnd[,Title])
hwnd - window handle returned by getwindow (can be NULL "" if a Title
is given)
Title - optional title of window - if given hwnd is ignored
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 105. setwindowbottom ΓòÉΓòÉΓòÉ
setwindowbottom
Place window at bottom of Z order (available on windows only) .
f=setwindowbottom(hwnd[,Title])
hwnd - window handle returned by getwindow (can be NULL "" if a Title
is given)
Title - optional title of window - if given hwnd is ignored
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 106. getforegroundwindow ΓòÉΓòÉΓòÉ
getforegroundwindow
Get window in the foreground.
hwnd=getforegroundwindow()
No Arguments
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 107. setforegroundwindow ΓòÉΓòÉΓòÉ
setforegroundwindow
Place window in the foreground.
f=setforegroundwindow(hwnd[,Title])
hwnd - window handle returned by getwindow (can be NULL "" if a Title
is given)
Title - optional title of window - if given hwnd is ignored
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 108. getwindowtitle ΓòÉΓòÉΓòÉ
getwindowtitle
Get window title.
title=getwindowtitle(hwnd)
hwnd - window handle returned by getwindow
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 109. setwindowtitle ΓòÉΓòÉΓòÉ
setwindowtitle
Set window title.
f=setwindowtitle(hwnd,title)
hwnd - window handle returned by getwindow
title - new title
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 110. getwindowvariable ΓòÉΓòÉΓòÉ
getwindowvariable
Get contents of a window to a variable.
f=getwindowvariable(hwnd,variablename)
hwnd - window handle returned by getwindow
variablename - name of variable to place the contents into
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 111. getwindowfile ΓòÉΓòÉΓòÉ
getwindowfile
Get contents of a window to a file.
f=getwindowvariable(hwnd,filename)
hwnd - window handle returned by getwindow
filename - name of file to place the contents into
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 04 Windows Functions.
ΓòÉΓòÉΓòÉ 112. Section 05 Keyboard/Mouse Event Functions ΓòÉΓòÉΓòÉ
Section 05 - Keyboard/Mouse Event Functions
sendmouseevent Sends a mouse event.
starteventscapture Captures all subsequent Mouse and Keyboard Events
to Filename.
stopeventscapture Stops capture of events started by
starteventscapture.
removelastevent Removes last event from Filename.
setcapslockon Sets Caps Lock ON.
setcapslockoff Sets Caps Lock OFF.
setcoordwindow Sets all following co-ordinates relative to a window.
Contents.
ΓòÉΓòÉΓòÉ 113. sendmouseevent ΓòÉΓòÉΓòÉ
sendmouseevent
sends a mouse event.
f=sendmouseevent(EventType[,x,y])
EventType - name of file
eventtype - "RELWINDOW MOVE WINDOWTITLE" move to co-ordinates x,y
(pixels) relative to window with title WINDOWTITLE
eventtype - "ABSOLUTE MOVE" move to absolute co-ordinates x,y (pixels)
eventtype - "MOVE" move relative to current position x,y pixels
eventtype - "CLICK" click left mouse button
eventtype - "DBLCLICK" double click left mouse button
eventtype - "LEFTDOWN" left mouse button down
eventtype - "LEFTUP" left mouse button up
eventtype - "RIGHTDOWN" right mouse button down
eventtype - "RIGHTUP" right mouse button up
eventtype - "MIDDLEDOWN" middle mouse button down
eventtype - "MIDDLEUP" middle mouse button up .
eventtype - "SETCURSOR APPSTARTING " Set mouse cursor to Standard arrow
and small hourglass
eventtype - "SETCURSOR ARROW " Set mouse cursor to s tandard arrow
eventtype - "SETCURSOR CROSS " Set mouse cursor to c rosshair
eventtype - "SETCURSOR IBEAM " Set mouse cursor to t ext I-beam
eventtype - "SETCURSOR ICON " Set mouse cursor to ( Windows NT only)
empty icon
eventtype - "SETCURSOR NO " Set mouse cursor to s lashed circle
eventtype - "SETCURSOR SIZE " Set mouse cursor to ( Windows NT only)
four-pointed arrow
eventtype - "SETCURSOR SIZEALL " Set mouse cursor to ( Windows NT only)
four-pointed arrow
eventtype - "SETCURSOR SIZENESW " Set mouse cursor to d ouble-pointed
arrow pointing northeast and southwest
eventtype - "SETCURSOR SIZENS " Set mouse cursor to d ouble-pointed
arrow pointing north and south
eventtype - "SETCURSOR SIZENWSE " Set mouse cursor to d ouble-pointed
arrow pointing northwest and southeast
eventtype - "SETCURSOR SIZEWE " Set mouse cursor to d ouble-pointed
arrow pointing west and east
eventtype - "SETCURSOR UPARROW " Set mouse cursor to v ertical arrow
eventtype - "SETCURSOR WAIT " Set mouse cursor to h ourglass
eventtype - "SETCURSOR DEFAULT" Set mouse cursor to default for each
window class
If SETCURSOR is used "SETCURSOR DEFAULT" must be given before the
process completes.
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 114. starteventscapture ΓòÉΓòÉΓòÉ
starteventscapture
Captures all subsequent Mouse and Keyboard Events to Filename until
stopeventscapture .
f=starteventscapture(Filename[ +])
Filename - name of file
[ +] - optional ' +' at end of the filename appends results to the
file , otherwise a new file is created.
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 115. stopeventscapture ΓòÉΓòÉΓòÉ
stopeventscapture
Stops capture of events started by starteventscapture .
f=stopeventscapture()
No Arguments
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 116. removelastevent ΓòÉΓòÉΓòÉ
removelastevent
Removes last event from Filename .
f=removelastevent(Filename)
Filename - name of file
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 117. setcapslockon ΓòÉΓòÉΓòÉ
setcapslockon
Sets Caps Lock ON .
f=setcapslockon()
No Arguments
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 118. setcapslockoff ΓòÉΓòÉΓòÉ
setcapslockoff
Sets Caps Lock OFF .
f=setcapslockoff()
No Arguments
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 119. setcoordwindow ΓòÉΓòÉΓòÉ
setcoordwindow
Sets all following co-ordinates relative to a window .
f=setcoordwindow(Title)
Title - title of window - NULL "" sets co-ordinates relative to the
desktop (Default)
Contents.
Section 05 Keyboard/Mouse Event Functions.
ΓòÉΓòÉΓòÉ 120. Section 06 Rexx Functions ΓòÉΓòÉΓòÉ
Section 06 - REXX Functions
runrexxscript Executes RexxScript with optional arguments.
runrexxscriptwindow Executes RexxScript as a separate process in a
window.
runrexxscriptmin Executes RexxScript as a separate process in a
minimised window.
runtempmaidscript* Executes temporary copy of a MAID script.
runtempmaidmultiscript* Executes temporary copy of a MAID script from
a multiscript file.
Contents.
ΓòÉΓòÉΓòÉ 121. runrexxscript ΓòÉΓòÉΓòÉ
runrexxscript
Executes RexxScript with optional arguments .
f=runrexxscript(RexxScript[,Argument0][,Argument1]...[,ArgumentN])
RexxScript - file name of Rexx script to run
Argument1 - optional argument 1
Argument0 - optional argument 0
...
ArgumentN - optional argument N
Contents.
Section 06 Rexx Functions.
ΓòÉΓòÉΓòÉ 122. runrexxscriptwindow ΓòÉΓòÉΓòÉ
runrexxscriptwindow
Executes RexxScript as a separate process in a window (available on
windows only. On OS/2 runs PMREXX) .
f=runrexxscriptwindow(RexxScript[,Argument])
RexxScript - file name of Rexx script to run
Argument - string of arguments separated by spaces
Contents.
Section 06 Rexx Functions.
ΓòÉΓòÉΓòÉ 123. runrexxscriptmin ΓòÉΓòÉΓòÉ
runrexxscriptmin
Executes RexxScript as a separate process in a minimised window
(available on windows only. On OS/2 runs PMREXX) .
f=runrexxscriptmin(RexxScript[,Argument])
RexxScript - file name of Rexx script to run
Argument - string of arguments separated by spaces
Contents.
Section 06 Rexx Functions.
ΓòÉΓòÉΓòÉ 124. runtempmaidscript ΓòÉΓòÉΓòÉ
runtempmaidscript
Executes temporary copy of a MAID script.
TempName=runtempmaidscript(MaidScript[-LISTEVENTTYPES-][,Directory[,NewName[,[-ARGLIST-Arguments-LIBLIST-]/LibraryList]]])
MaidScript - file name of Maid script to run (in windows this script
may be a compressed script). If the filename is followed by the string
"-LISTEVENTTYPES-" the temporary copy contains a list of the event types
- else the temporary copy is empty.
Directory - optional directory for the temporary script - default temp
directory.
NewName - optional new filename for the file. If this is "" a temporary
name is used.
Arguments/LibraryList - optional argument list followed by a library
list.
If there is an argument list, the first argument must be "-ARGLIST-" and
if there is a
library list after the arguments then "-LIBLIST-" must apprear after the
arguments.
A Stemlist is created using the returned TempName
MAIDArgs!.0 Contains the number of arguments
MAIDArgs!.1 Contains the first argument
...
MAIDArgs!.n Contains the n th argument
eg to retrieve the arguments use
f=readstemlist(TempName,"MAIDArgs!")
do i=1 to MAIDArgs!.0
say "Argument " i "is" MAIDArgs!.i
end
The optional library list is a list of filenames seperated by commas
where each file contains REXX code or library functions to be appended
onto the original MaidScript.
Both the MaidScript file and LibraryList files may be compressed
scripts.
eg
Library list only -
TempName=runtempmaidscript("MyScript.mde","C:\MyScripts","MyScript",Library1","Library2")
Argument list with library list -
TempName=runtempmaidscript("MyScript.mde","C:\MyScripts","MyScript","-ARGLIST-","arg1","arg2","arg3","-LIBLIST-","Library1","Library2")
returns
RESULT.TITLE -title of the MaidScript
TempName - temporary filename of the MaidScript - this file is
automatically deleted when the MaidScript dialog closes
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 06 Rexx Functions.
ΓòÉΓòÉΓòÉ 125. runtempmaidmultiscript ΓòÉΓòÉΓòÉ
runtempmaidmultiscript
Executes temporary copy of a MAID script from a multiscript file.
TempName=runtempmaidmultiscript(MultiFile,MaidScript[-LISTEVENTTYPES-][,Directory[,NewName[,[-ARGLIST-Arguments-LIBLIST-]/LibraryList]]])
MultiFile - file name of Maid multi script to run. A multi script file
is simply a concatenation of files and must have been created with the
importfilestofile function. (in windows this multifile may be a
compressed file)
The files are exported using the exportfilesfromfile function and then
runtempmaidscript is run using the MaidScript file.
This allows you to concatenate all the script files in a project
together into a single multi script file.
MaidScript - file name of Maid script to run (in windows this script
may be a compressed script). If the filename is followed by the string
"-LISTEVENTTYPES-" the temporary copy contains a list of the event types
- else the temporary copy is empty.
Directory - optional directory for the temporary script - default temp
directory.
NewName - optional new filename for the file. If this is "" a temporary
name is used.
Arguments/LibraryList - optional argument list followed by a library
list.
If there is an argument list, the first argument must be "-ARGLIST-" and
if there is a
library list after the arguments then "-LIBLIST-" must apprear after the
arguments.
A Stemlist is created using the returned TempName
MAIDArgs!.0 Contains the number of arguments
MAIDArgs!.1 Contains the first argument
...
MAIDArgs!.n Contains the n th argument
eg to retrieve the arguments use
f=readstemlist(TempName,"MAIDArgs!")
do i=1 to MAIDArgs!.0
say "Argument " i "is" MAIDArgs!.i
end
The optional library list is a list of filenames seperated by commas
where each file contains REXX code or library functions to be appended
onto the original MaidScript.
Both the StartupFile and LibraryList files may be compressed scripts.
eg
Library list only -
TempName=runtempmaidmultiscript("MultiFile","MyScript.mde","C:\MyScripts","MyScript",Library1","Library2")
Argument list with library list -
TempName=runtempmaidmultiscript("MultiFile","MyScript.mde","C:\MyScripts","MyScript","-ARGLIST-","arg1","arg2","arg3","-LIBLIST-","Library1","Library2")
returns
RESULT.TITLE -title of the MaidScript
TempName - temporary filename of the MaidScript - this file is
automatically deleted when the MaidScript dialog closes
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 06 Rexx Functions.
ΓòÉΓòÉΓòÉ 126. Section 07 Registry Functions ΓòÉΓòÉΓòÉ
Section 07 - Registry Functions
dirregistry Creates StemVariable containing info on Registry.
getkeyvalues Create StemVariable with Key values for Registry
setkeyvalue Modifies/Creates key value/data - creates key if it does
not exist
deletekey Deletes an existing key
deletekeyvalue Deletes value from a key
Contents.
ΓòÉΓòÉΓòÉ 127. dirregistry ΓòÉΓòÉΓòÉ
dirregistry
Creates StemVariable containing info on Registry .
f=dirregistry(Registry,StemVariable)
Registry - directory path of registryname of file
Registry can be one of -
"HKEY_CLASSES_ROOT\pathname"
"HKEY_CURRENT_USER\pathname"
"HKEY_LOCAL_MACHINE\pathname"
"HKEY_USERS\pathname"
where \pathname can be a directory path or empty (NULL)
Note:
Under OS/2 only valid key under HKEY_CURRENT_USER is
HKEY_CURRENT_USER\SOFTWARE
Under OS/2 only valid keys under HKEY_LOCAL_MACHINE are
HKEY_LOCAL_MACHINE\SOFTWARE
HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET
Under OS/2 only valid key under HKEY_USERS is
HKEY_USERS\.DEFAULT
StemVariable - name of Stem Variable to place information
StemVariable 0 - number of entries
...
StemVariable .i - Entry for ith directory entry
Contents.
Section 07 Registry Functions.
ΓòÉΓòÉΓòÉ 128. getkeyvalues ΓòÉΓòÉΓòÉ
getkeyvalues
Create StemVariable with Key values for Registry .
f=getkeyvalues(Registry,StemVariable)
Registry - directory path of registryname of file
Registry can be one of -
"HKEY_CLASSES_ROOT\pathname"
"HKEY_CURRENT_USER\pathname"
"HKEY_LOCAL_MACHINE\pathname"
"HKEY_USERS\pathname"
where \pathname can be a directory path or empty (NULL)
Note:
Under OS/2 only valid key under HKEY_CURRENT_USER is
HKEY_CURRENT_USER\SOFTWARE
Under OS/2 only valid keys under HKEY_LOCAL_MACHINE are
HKEY_LOCAL_MACHINE\SOFTWARE
HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET
Under OS/2 only valid key under HKEY_USERS is
HKEY_USERS\.DEFAULT
StemVariable - name of Stem Variable to place information
StemVariable .0 - number of key values
StemVariable .NAME.1 - Name of Entry for 1st key value
StemVariable .DATA.1 - Data of Entry for 1st key value
...
StemVariable .NAME.i - Name of Entry for ith key value
StemVariable .DATA.i - Data of Entry for ith key value
Contents.
Section 07 Registry Functions.
ΓòÉΓòÉΓòÉ 129. setkeyvalue ΓòÉΓòÉΓòÉ
setkeyvalue
Modifies/Creates key value/data - creates key if it does not exist.
f=setkeyvalue(Registry,Key,ValueName,ValueData)
Registry - directory path of registryname of file
Registry can be one of -
"HKEY_CLASSES_ROOT\pathname"
"HKEY_CURRENT_USER\pathname"
"HKEY_LOCAL_MACHINE\pathname"
"HKEY_USERS\pathname"
where \pathname can be a directory path or empty (NULL)
Note:
Under OS/2 only valid key under HKEY_CURRENT_USER is
HKEY_CURRENT_USER\SOFTWARE
Under OS/2 only valid keys under HKEY_LOCAL_MACHINE are
HKEY_LOCAL_MACHINE\SOFTWARE
HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET
Under OS/2 only valid key under HKEY_USERS is
HKEY_USERS\.DEFAULT
Key - name of Key to create. ignored if empty
ValueName - Value name of entry
ValueData - Value data in entry
Contents.
Section 07 Registry Functions.
ΓòÉΓòÉΓòÉ 130. deletekey ΓòÉΓòÉΓòÉ
deletekey
Deletes an existing key.
f=deletekey(Registry)
Registry - directory path of registryname of file
Registry can be one of -
"HKEY_CLASSES_ROOT\pathname"
"HKEY_CURRENT_USER\pathname"
"HKEY_LOCAL_MACHINE\pathname"
"HKEY_USERS\pathname"
where \pathname can be a directory path or empty (NULL)
Note:
Under OS/2 only valid key under HKEY_CURRENT_USER is
HKEY_CURRENT_USER\SOFTWARE
Under OS/2 only valid keys under HKEY_LOCAL_MACHINE are
HKEY_LOCAL_MACHINE\SOFTWARE
HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET
Under OS/2 only valid key under HKEY_USERS is
HKEY_USERS\.DEFAULT
Contents.
Section 07 Registry Functions.
ΓòÉΓòÉΓòÉ 131. deletekeyvalue ΓòÉΓòÉΓòÉ
deletekeyvalue
Deletes value from a key.
f=deletekeyvalue(Registry,ValueName)
Registry - directory path of registryname of file
Registry can be one of -
"HKEY_CLASSES_ROOT\pathname"
"HKEY_CURRENT_USER\pathname"
"HKEY_LOCAL_MACHINE\pathname"
"HKEY_USERS\pathname"
where \pathname can be a directory path or empty (NULL)
Note:
Under OS/2 only valid key under HKEY_CURRENT_USER is
HKEY_CURRENT_USER\SOFTWARE
Under OS/2 only valid keys under HKEY_LOCAL_MACHINE are
HKEY_LOCAL_MACHINE\SOFTWARE
HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET
Under OS/2 only valid key under HKEY_USERS is
HKEY_USERS\.DEFAULT
ValueName - Value name of entry
Contents.
Section 07 Registry Functions.
ΓòÉΓòÉΓòÉ 132. Section 08 Global Stem Variable Functions ΓòÉΓòÉΓòÉ
Section 08 - Global Stem Variable Functions
writestemlist Write to stemlist.
readstemlist Read from stemlist.
writeallstemlist Clears stemlist and writes all stem variables to
stemlist.
readallstemlist Reads all stem variable from stemlist and leaves items
on the list.
peekstemlist Read from stemlist.
readstemlistitem Read item from stemlist.
peekstemlistitem Read item from stemlist.
stemlisttofile Dump stemlist to a file.
stemlistfromfile Import file entries to stemlist.
stemvartofile Dump stem variable to a file.
stemvarfromfile Import stem variable from file.
sizeofstemlist Get no of entries in stemlist.
freestemlist Frees existing stemlist.
getstemtails* Gets tails of a stem variable.
reducestemvariable* Reduces a stem variable by removong all null
entries.
getstemidlist* Gets a list of all non NULL ID's belonging to a stem in
a stemlist.
getstemtargetlist* Gets a list of all non NULL target strings
belonging to a stem in a stemlist.
savelocalstems* Writes local stem variables to local memory.
restorelocalstems* Reads local stem variables from local memory.
Contents.
ΓòÉΓòÉΓòÉ 133. writestemlist ΓòÉΓòÉΓòÉ
writestemlist
writes stem variable to stemlist.
f=writestemlist(StemList,StemVariable[,ID][,Target])
StemList - name of stem list
StemVariable - stem variable to write
ID - optional number to identify the type of data - default 0
Target - optional AlphaNumeric String to identify who the data is for -
default empty string
Up to 90 Stems can be written to the stemlist
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 134. readstemlist ΓòÉΓòÉΓòÉ
readstemlist
Reads stem variable from stemlist and removes item from the list.
f=readstemlist(StemList,OldStemName[,NewStemName[,ID][,Target]])
RESULT.0 contains the number of entries in the stem variable
RESULT.STEMNAME contains the original stem name
RESULT.TARGET contains the original target name
RESULT.1 contains the name extension of the 1st stem variable entry
...
RESULT.n contains the name extension of the nth stem variable entry
StemList - name of stem list
OldStemName - name of stem variable before it was added to the stemlist
if OldStemName is empty (NULL) the first stem found is read
Optional Arguments-
NewStemName - new stem name - stem variable to read data into
if NewStemName is empty (NULL) or not defined it is the old stem name of
the stem found
ID - optional number to identify the type of data - default 0
Target - optional AlphaNumeric String to identify who the data is for -
default empty string
returns
RESULT.0 no of elements in the stem
RESULT.ID ID of the stem
RESULT.TARGET Target of the stem
RESULT.OLDSTEMNAME Original stem name of the stem
RESULT.NEWSTEMNAME New stem name of the stem
RESULT.ITEMNO Item number in the list
StemList.||RESULT.1 - 1st stem variable name extension
...
StemList.||RESULT.n - nth stem variable name extension
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 135. writeallstemlist ΓòÉΓòÉΓòÉ
writeallstemlist
Clears stemlist and writes all stem variables to stemlist.
f=writeallstemlist(StemList)
StemList - name of stem list
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 136. readallstemlist ΓòÉΓòÉΓòÉ
readallstemlist
Reads all stem variable from stemlist and leaves items on the list.
f=readallstemlist(StemList)
StemList - name of stem list
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 137. peekstemlist ΓòÉΓòÉΓòÉ
peekstemlist
Reads stem variable from stemlist and does not remove the item from the
list.
Item=peekstemlist(StemList,OldStemName,Item[,NewStemName[,ID][,Target]])
RESULT.0 contains the number of entries in the stem variable
RESULT.STEMNAME contains the original stem name
RESULT.TARGET contains the original target name
RESULT.1 contains the name extension of the 1st stem variable entry
...
RESULT.n contains the name extension of the nth stem variable entry
StemList - name of stem list
OldStemName - name of stem variable before it was added to the stemlist
if OldStemName is empty (NULL) the first stem found is read
Item - item number to peek
Optional Arguments-
NewStemName - new stem name - stem variable to read data into
if NewStemName is empty (NULL) or not defined it is the old stem name of
the stem found
ID - optional number to identify the type of data - default 0
Target - optional AlphaNumeric String to identify who the data is for -
default empty string
returns
Item - next item number to peek - returns -1 if no item found
RESULT.0 no of elements in the stem
RESULT.ID ID of the stem
RESULT.TARGET Target of the stem
RESULT.OLDSTEMNAME Original stem name of the stem
RESULT.NEWSTEMNAME New stem name of the stem
RESULT.ITEMNO Item number in the list
StemList.||RESULT.1 - 1st stem variable name extension
...
StemList.||RESULT.n - nth stem variable name extension
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 138. readstemlistitem ΓòÉΓòÉΓòÉ
readstemlistitem
Reads stem variable from stemlist and removes item from the list.
f=readstemlistitem(StemList,StemVariable,Item)
RESULT.0 contains the number of entries in the stem variable
RESULT.STEMNAME contains the original stem name
RESULT.TARGET contains the original target name
RESULT.1 contains the name extension of the 1st stem variable entry
...
RESULT.n contains the name extension of the nth stem variable entry
StemList - name of stem list
StemVariable - stem variable to read data into
Item - item number to read
returns
RESULT.0 no of elements in the stem
RESULT.ID ID of the stem
RESULT.TARGET Target of the stem
RESULT.OLDSTEMNAME Original stem name of the stem
RESULT.NEWSTEMNAME New stem name of the stem
RESULT.ITEMNO Item number in the list
StemList.||RESULT.1 - 1st stem variable name extension
...
StemList.||RESULT.n - nth stem variable name extension
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 139. peekstemlistitem ΓòÉΓòÉΓòÉ
peekstemlistitem
Reads stem variable from stemlist and does not remove the item from the
list.
Item=peekstemlistitem(StemList,StemVariable,Item)
RESULT.0 contains the number of entries in the stem variable
RESULT.STEMNAME contains the original stem name
RESULT.TARGET contains the original target name
RESULT.1 contains the name extension of the 1st stem variable entry
...
RESULT.n contains the name extension of the nth stem variable entry
StemList - name of stem list
StemVariable - stem variable to read data into
Item - item number to peek
returns
Item - next item number to peek - returns -1 if no item found
RESULT.0 no of elements in the stem
RESULT.ID ID of the stem
RESULT.TARGET Target of the stem
RESULT.OLDSTEMNAME Original stem name of the stem
RESULT.NEWSTEMNAME New stem name of the stem
RESULT.ITEMNO Item number in the list
StemList.||RESULT.1 - 1st stem variable name extension
...
StemList.||RESULT.n - nth stem variable name extension
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 140. stemlisttofile ΓòÉΓòÉΓòÉ
stemlisttofile
Dump stemlist to a file, Stems are appended to the file
f=stemlisttofile(StemList,Filename[ +])
StemList - name of stem list
Filename - name of file to place stems in
[ +] - optional ' +' at end of the filename appends results to the
file , otherwise a new file is created.
File Format :-
*STEMNAME;ID;TARGET;
STEM.NAME.ONE="contents of stem name one"
STEM.NAME.TWO="contents of stem name two"
...
STEM.NAME.N="contents of stem name n"
Repeat for each stem
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 141. stemlistfromfile ΓòÉΓòÉΓòÉ
stemlistfromfile
Import file entries to stemlist. Stems are appended onto the stemlist
f=stemlistfromfile(StemList,Filename)
StemList - name of stem list
Filename - name of file to to read stems from
File Format :-
*STEMNAME;ID;TARGET;
STEM.NAME.ONE="contents of stem name one"
STEM.NAME.TWO="contents of stem name two"
...
STEM.NAME.N="contents of stem name n"
Repeat for each stem
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 142. stemvartofile ΓòÉΓòÉΓòÉ
stemvartofile
Dump stem variable to a file.
f=stemvartofile(Filename[ +],StemVariable[,ID][,Target])
Filename - name of file to read stems from
[ +] - optional ' +' at end of the filename appends results to the
file , otherwise a new file is created.
StemVariable - stem variable to write
ID - optional number to identify the type of data - default 0
Target - optional AlphaNumeric String to identify who the data is for -
default empty string
File Format :-
*STEMNAME;ID;TARGET;
STEMNAME.ONE="contents of stem name one"
STEMNAME.TWO="contents of stem name two"
...
STEMNAME.N="contents of stem name n"
Repeat for each stem
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 143. stemvarfromfile ΓòÉΓòÉΓòÉ
stemvarfromfile
Import stem variable from file.
f=stemvarfromfile(Filename,Stem)
Filename - name of file to read stems from
Stem - name of stem variable
returns
RESULT.0 no of elements in the stem
RESULT.ID ID of the stem
RESULT.TARGET Target of the stem
RESULT.STEMNAME Original stem name of the stem
StemList.||RESULT.1 - 1st stem variable name extension
...
StemList.||RESULT.n - nth stem variable name extension
File Format :-
*STEMNAME;ID;TARGET;
STEMNAME.ONE="contents of stem name one"
STEMNAME.TWO="contents of stem name two"
...
STEMNAME.N="contents of stem name n"
Repeat for each stem
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 144. sizeofstemlist ΓòÉΓòÉΓòÉ
sizeofstemlist
Returns number of stems in stemlist.
nostems=sizeofstemlist(StemList)
StemList - name of stem list
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 145. freestemlist ΓòÉΓòÉΓòÉ
freestemlist
Frees existing stemlist.
f=freestemlist(StemList)
StemList - name of stem list
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 146. getstemtails ΓòÉΓòÉΓòÉ
getstemtails
Gets tails of a stem variable.
getstemtails(StemName,StemVariable)
StemName - name of stem
StemVariable - name of stem variable containing the results
StemVariable.0 no of elements in the stem
StemVariable.1 - 1st stem variable name extension
...
StemVariable.n - nth stem variable name extension
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 147. reducestemvariable ΓòÉΓòÉΓòÉ
reducestemvariable
Reduces a stem variable by removong all null entries.
f=reducestemvariable(StemName)
StemName - name of stem
The StemName must be of the form
StemName.0 - number of entries
StemName.1 - first entry
...
StemName.n - nth entry
All NULL entries are removed and StemName.0 adjusted to relect the new
count.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 148. getstemidlist ΓòÉΓòÉΓòÉ
getstemidlist
Gets a list of all non NULL ID's belonging to a stem in a stemlist.
f=getstemidlist(StemList,OldStemName,StemVariable)
StemList - name of stem list
OldStemName - name of stem variable before it was added to the stemlist
StemVariable - name of stem variable containing the results
The StemVariable is of the form
StemVariable.0 - number of entries
StemVariable.1 - first entry
...
StemVariable.n - nth entry
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 149. getstemtargetlist ΓòÉΓòÉΓòÉ
getstemtargetlist
Gets a list of all non NULL target strings belonging to a stem in a
stemlist.
f=getstemtargetlist(StemList,OldStemName,StemVariable)
StemList - name of stem list
OldStemName - name of stem variable before it was added to the stemlist
StemVariable - name of stem variable containing the results
The StemVariable is of the form
StemVariable.0 - number of entries
StemVariable.1 - first entry
...
StemVariable.n - nth entry
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 08 Global Stem Variable Functions.
savelocalstems* Writes all local stem variables to local memory.
restorelocalstems* Reads all local stem variable from local memory.
ΓòÉΓòÉΓòÉ 150. savelocalstems ΓòÉΓòÉΓòÉ
savelocalstems
Writes local stem variables to local memory .
f=savelocalstems([StemList,Filename])
StemList - Optional Argument - A list of stemnames to be saved
separated by spaces. Any stemname that starts with one of the names in
the list will be saved. eg "JIM LES" will save all stems starting with
JIM or LES
Filename - Optional Filename - file to save the StemList data in if
StemList is defined.
If No argument is supplied then all stems are saved.
This memory is only accessible from the current process;
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 151. restorelocalstems ΓòÉΓòÉΓòÉ
restorelocalstems
Reads local stem variables from local memory .
f=restorelocalstems([StemList,Filename])
StemList - Optional Argument - A list of stemnames to be restored
separated by spaces. Any stemname that starts with one of the names in
the list will be restored. eg "JIM LES" will restore all stems starting
with JIM or LES
Filename - Optional Filename - file from which to restore the StemList
data if StemList is defined.
Filename must have been defined with the previous savelocalstems call.
If No argument is supplied then all stems are restored.
This memory is only accessible from the current process;
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 08 Global Stem Variable Functions.
ΓòÉΓòÉΓòÉ 152. Section 09 General Functions ΓòÉΓòÉΓòÉ
Section 09 - General Functions
pause Pause in milliseconds.
beep Beeps at Frequency for Duration milliseconds.
execute Executes Filename.
syscommand* Executes System Command.
getosversion Get operating system version information.
listprinters List available printers to a stem variable.
getdefaultprinter Returns default printer.
setdefaultprinter Set default printer.
printstring* Print string to default printer.
printfile* Print file to default printer.
playwave Play a wave file.
importwindow* Import a desktop window to become a child of a parent
desktop window .
exportwindow* Export a child desktop window imported with
importwindow .
validatestringchars* Validates that a string only contains certain
characters.
removestringchars* Removes certain characters from a string.
addfuncfromfile* Add a list of functions from a file.
closethreadhandles* Close thread handles from non-active threads.
validatestringformat* Validate the format of a string.
getrexxioversion* Returns the REXXIO version information .
reformatdatestring* Reformats a date string.
messagebeep Plays a waveform sound or beeps the system speaker.
Contents.
ΓòÉΓòÉΓòÉ 153. pause ΓòÉΓòÉΓòÉ
pause
Pause in milliseconds .
f=pause(Millisecs)
Millisecs - number of milli-seconds to pause
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 154. beep ΓòÉΓòÉΓòÉ
beep
Beeps at Frequency for Duration milliseconds .
f=beep(Frequency,Duration)
Frequency - frequency of beep
Duration - duration of beep in milliseconds
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 155. execute ΓòÉΓòÉΓòÉ
execute
Executes Filename with Parameters in DefaultDirectory .
f=execute(Filename[,Parameters][,DefaultDirectory][,Show])
Filename - name of file
Parameters - parameters to pass
DefaultDirectory - default directory to run in
Show - how to run the window
Show can be -
"SHOWNORMAL"
"HIDE"
"MAXIMIZE"
MINIMIZE"
"RESTORE"
"SHOWDEFAULT"
"SHOWMAXIMIZED"
"SHOWMINIMIZED"
"SHOWMINNOACTIVE"
"SHOWNA"
"SHOWNOACTIVATE"
"SHOW"
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 156. syscommand ΓòÉΓòÉΓòÉ
syscommand
Executes System Command .
ReturnCode=syscommand(SystemCommand[,"NOWAIT"])
SystemCommand - system command to execute
"NOWAIT" - do not wait for the System Command to complete
e.g. "dir > file1" places a directory list into file1
"sort /R < file1 > file2" runs sort on file1 with output to file2
If "NOWAIT" is NOT passed as an argument the Return Code of the process
is passed back, else 0 is returned.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 157. getosversion ΓòÉΓòÉΓòÉ
getosversion
Returns the operating system version information .
osversion=getosversion()
No Arguments
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 158. listprinters ΓòÉΓòÉΓòÉ
listprinters
List available printers to a stem variable (available on windows only).
f=listprinters(StemVariable[,PrinterType])
StemVariable - name Stem Variable to place results in
PrinterType - optional - valid for NT only - if left out list local
printers only.
can be one of the following (separated by commas e.g.
"LOCAL,CONNECTIONS") -
LOCAL - list local printers (Default)
CONNECTIONS - list printers to which the user has made previous
connections
NETWORK - list network printers in the computers domain
REMOTE - list network printers and print servers in the computers domain
StemVariable .0 - number of printers
...
StemVariable .i - Entry for ith printer
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 159. getdefaultprinter ΓòÉΓòÉΓòÉ
getdefaultprinter
Returns default printer (available on windows only).
DefaultPrinter=getdefaultprinter()
No Arguments
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 160. setdefaultprinter ΓòÉΓòÉΓòÉ
setdefaultprinter
Set default printer (available on windows only).
f=setdefaultprinter(PrinterName)
PrinterName - name of printer
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 161. printstring ΓòÉΓòÉΓòÉ
printstring
Print string to default printer.
f=printstring(PrintString)
PrintString - string to print
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 162. printfile ΓòÉΓòÉΓòÉ
printfile
Print file to default printer.
f=printfile(FileName)
FileName - file to print
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 163. playwave ΓòÉΓòÉΓòÉ
playwave
Play a wave file (available on windows only).
f=playwave(WaveFileName[,SyncFlag])
WaveFileName - name of .wav wave file to play
SyncFlag - optional flag - 0 for async playback, 1 for sync playback -
default 0
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 164. importwindow ΓòÉΓòÉΓòÉ
importwindow
Import a desktop window to become a child of a parent desktop
window(available on windows only).
f=importwindow(ParentWindow,ChildWindow[,Xposition,Yposition,Width,Height])
ParentWindow - title of desktop window that will contain the child to
be imported
ChildWindow - title of child desktop window to be imported from the
desktop
Xposition - (optional)x coordinate of the child window (Default entire
client area of Parent)
Yposition, - (optional)y coordinate of the child window
Width - (optional)width of the child window
Height - (optional) height of the child window
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 165. exportwindow ΓòÉΓòÉΓòÉ
exportwindow
Export a child desktop window imported with importwindow (available on
windows only).
f=exportwindow(ParentWindow[,Xposition,Yposition,Width,Height])
ParentWindow - title of desktop window that contains the child to be
exported
Xposition - (optional)x coordinate of the exported window on the desktop
(Default existing child size)
Yposition, - (optional)y coordinate of the exported window on the
desktopw
Width - (optional)width of the exported window on the desktop
Height - (optional) height of the exported window on the desktop
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 166. validatestringchars ΓòÉΓòÉΓòÉ
validatestringchars
Validates that a string only contains certain characters.
f=validatestringchars(Filename,CharList,ValidateType)
Filename - name of file
CharList - list of characters
ValidateType - 1 or 0.
If 1 validates string only contains characters in CharList..
If 0 validates string only contains characters not in CharList..
Returns 1 if the string is valid, else returns 0.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 167. removestringchars ΓòÉΓòÉΓòÉ
removestringchars
Removes certain characters from a string.
newstring=removestringchars(Filename,CharList,ValidateType)
Filename - name of file
CharList - list of characters
ValidateType - 1 or 0.
If 1 removes characters in CharList from the string.
If 0 removes characters not in CharList from the string.
Returns string with characters removed.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 168. addfuncfromfile ΓòÉΓòÉΓòÉ
addfuncfromfile
Add a list of functions from a file.
f=addfuncfromfile(Filename)
Filename - name of file
Each line contains name, module and procedure seperated by commas.
eg
Func1,FUNC1DLL,func1
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 169. closethreadhandles ΓòÉΓòÉΓòÉ
closethreadhandles
Close thread handles from non-active threads (available on windows
only) .
f=closethreadhandles()
No Arguments
Some dll's create threads and leave the thread handle open after the
thread has stopped running. This function searches for those handles and
closes them.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 170. validatestringformat ΓòÉΓòÉΓòÉ
validatestringformat
Validate the format of a string.
f=validatestringformat(String,stemformat[,Frequency,Duration])
String - string to test
stemformat - stemname of stem containing the formatting validation
information
Frequency - optional - frequency of beep if an error occurs
Duration - optional - duration of beep in milliseconds if an error
occurs
stemformat.TYPE - can be one of
"INTEGER" - integer comprising of digits only
"DECIMAL" - decimal number
"ALPHANUMERIC" - alphanumeric chars
"ALPHA" - alpha characters only
"ANYCHARS" - any characters allowed
"SETMESSAGE" - sets error messages to the custom message - only needs to
be called once per process - messages can be up to 255 characters long
stemformat.INTEGER - custom error message if invalid integer number -
ignored if NULL "" and set if stemformat.TYPE is "SETMESSAGE"
stemformat.DECIMAL - custom error message if invalid decimal number -
ignored if NULL "" and set if stemformat.TYPE is "SETMESSAGE"
stemformat.ALPHANUMERIC - custom error message if invalid alphanumeric
string - ignored if NULL "" and set if stemformat.TYPE is "SETMESSAGE"
stemformat.ALPHA - custom error message if invalid alpha string -
ignored if NULL "" and set if stemformat.TYPE is "SETMESSAGE"
stemformat.MINMESSAGE - custom error message if string below
stemformat.MIN length - ignored if NULL "" and set if stemformat.TYPE is
"SETMESSAGE"
stemformat.MAXMESSAGE - custom error message if string below
stemformat.MIN length - ignored if NULL "" and set if stemformat.TYPE is
"SETMESSAGE"
stemformat.MINNUMBERMESSAGE - custom error message if string below
stemformat.MIN length - ignored if NULL ""
stemformat.MAXNUMBERMESSAGE - custom error message if string below
stemformat.MIN length - ignored if NULL "" and set if stemformat.TYPE is
"SETMESSAGE"
stemformat.DECPLACEBEFOREMESSAGE - custom error message if string below
stemformat.MIN length - ignored if NULL "" and set if stemformat.TYPE is
"SETMESSAGE"
stemformat.DECPLACEAFTERMESSAGE - custom error message if string below
stemformat.MIN length - ignored if NULL "" and set if stemformat.TYPE is
"SETMESSAGE"
Default messages -
stemformat. MINMESSAGE - "string shorter than minimum length"
stemformat. MAXMESSAGE - "string longer than maximum length"
stemformat. MINNUMBERMESSAGE - "number below minimum specified"
stemformat. MAXNUMBERMESSAGE - "number above maximum specified"
stemformat. DECPLACEBEFOREMESSAGE - "wrong number of decimal places
before decimal point"
stemformat. DECPLACEAFTERMESSAGE - "wrong number of decimal places after
decimal point"
stemformat. INTEGER - "invalid integer number"
stemformat. DECIMAL - "invalid decimal number"
stemformat. ALPHANUMERIC - "invalid alphanumeric string"
stemformat. ALPHA - "invalid alpha string"
stemformat.MIN - minimum length of string - ignored if NULL ""
stemformat.MAX - maximum length of string - ignored if NULL ""
stemformat.MINNUMBER - if type "INTEGER" or "DECIMAL" smallest number
allowed - ignored if NULL ""
stemformat.MAXNUMBER - if type "INTEGER" or "DECIMAL" largest number
allowed - ignored if NULL ""
stemformat.DECPLACEBEFORE - if type "DECIMAL" number of deciaml places
before the decimal point - ignored if NULL ""
stemformat.DECPLACEAFTER - if type "DECIMAL" number of deciaml places
after the decimal point - ignored if NULL ""
stemformat.IGNOREUNTILVALID - "YES" will not check for MIN MINNUMBER
DECPLACEBEFORE and DECPLACEAFTER if the string is less than the required
value - set to "YES" if a NULL "" string is passed - set to NULL "" once
the string is within range - ignored if NULL ""
stemformat.ERRMESSAGE - error message - NULL "" if no error
stemformat.NEWSTRING - corrected string
Returns 1 if the string is valid, else returns 0.
The string with any illegal characters removed is returned in
stemformat.NEWSTRING .
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 171. getrexxioversion ΓòÉΓòÉΓòÉ
getrexxioversion
Returns the REXXIO version information .
rexxioversion=getrexxioversion()
No Arguments
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 172. reformatdatestring ΓòÉΓòÉΓòÉ
reformatdatestring
Reformats a date string .
newdatestring=reformatdatestring(OldDatestring,OldFormat,NewFormat)
OldDatestring - duration of beep in milliseconds if an error occurs
OldFormat - String containing formatiing characters
NewFormat - String containing formatiing characters
Formating characters -
YYYY - Four digit year eg 1999 2000
YY - Two digit year eg 99 00
MMM - Month - Three chars eg Jan Feb Mar Apr May Jun Jul Aug Sep Oct
Nov Dec
MM - Month - Two digits eg 01 02 03 04 05 06 07 08 09 10 11 12
DD - Day - Two digits eg 01 02 03 04 05 06 07 08 09 10 ... 31
hh - Hours - Two digits
mm - Minutes - Two digits
ss - Seconds - Two digits
eg
newdatestring=reformatdatestring("1999-03-25 12:13:14","YYYY-MM-DD
hh:mm:ss","MM/DD/YY")
sets newdatestring to "03/25/99"
newdatestring=reformatdatestring(OldDatestring,OldFormat,NewFormat)
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 173. messagebeep ΓòÉΓòÉΓòÉ
messagebeep
Beeps the system speaker for Duration milliseconds. (available on
windows only)
f=messagebeep(Waveform)
Waveform - type of waveform sound to play
can be one of -
"STANDARD" - Standard beep using the computer speaker
"ICONASTERISK" - System Asterisk
"ICONEXCLAMATION" - System Exclamation
"ICONHAND" - System Hand
"ICONQUESTION" - System Question
"OK" - System Default
Contents.
Section 09 General Functions.
ΓòÉΓòÉΓòÉ 174. Section 10 Comms Functions ΓòÉΓòÉΓòÉ
Section 10 - Comms Functions
opencommport* Open Comm Port.
closecommport* Close Comm Port.
readcommport* Read from Comm Port.
writecommport* Write to Comm Port.
readcommtofile* Read from Comm Port to file.
stopreadcommtofile* Stop Read from Comm Port to file.
writecommfromfile* Write from file to Comm Port.
writewaitreplycomm* Write to Comm Port. and wait for reply.
clearcommbuffer* Flushes the transmit buffer.
Contents.
ΓòÉΓòÉΓòÉ 175. opencommport ΓòÉΓòÉΓòÉ
opencommport
Open Comm Port (available on windows only).
f=opencommport(CommPort[,BaudRate[,ByteSize[,Parity[,StopBits[,Protocol]]]])
CommPort - comm port number eg COM1
BaudRate - comm port speed - default 9600
ByteSize - 4,5,6,7 or 8 - default 8
Parity - no,odd,even,mark,space - default no
StopBits - 1,1.5,2 - default 1
Protocol - string defining protocol to use - can be combination of
"RTSCTS" "DTRDSR" "XONXOFF"
RTSCTS - request-to-send clear-to-send
DTRDSR - data-terminal-ready data-set-ready
XONXOFF -XON XOFF flow control
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 176. closecommport ΓòÉΓòÉΓòÉ
closecommport
Close Comm Port (available on windows only).
f=closecommport(CommPort)
CommPort - comm port number eg COM1
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 177. readcommport ΓòÉΓòÉΓòÉ
readcommport
Read from Comm Port (available on windows only).
string=readcommport(CommPort[,NoChars[,[READ[RESET]]Timeout]])
CommPort - comm port number eg COM1
NoChars - no of chars to read - waits for the comm port to receive the
chars - default to 1
Timeout - if nothing read after Timeout millisecs then return - set to
zero (0) for no timeout (default)
If preceded by the chars "READ" (do not include quotes) the entire read
function timesout after Timeout Millisecs,
otherwise it waits for an initial response within Timeout Millisecs.
If "READ" is followed by the chars "RESET" (do not include quotes) eg
"READRESET" the timeout starts from the last character read in, else the
timeout starts from the first character read in.
e.g. if Timeout="READ60000" the function will return after 1 minute
regardless of how many chars are read in. If Timeout="60000" the
function will return after 1 minute if no chars have been read but will
not timeout if chars have been read in the first minute.
The Comm Port must be opened with the opencommport function.
Returns
String of chars read from commport.
RESULT.TIMEOUT - 0 if no timeout - 1 if timeout occured
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 178. writecommport ΓòÉΓòÉΓòÉ
writecommport
Write to Comm Port (available on windows only).
nobyteswritten=writecommport(CommPort,String[,WriteTimeout])
CommPort - comm port number eg COM1
String - string to write to the comm port
WriteTimeout - if nothing written after Timeout millisecs then return -
set to zero (0) for no timeout (default)
The Comm Port must be opened with the opencommport function.
Returns no of bytes written.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 179. readcommtofile ΓòÉΓòÉΓòÉ
readcommtofile
Read from Comm Port to file (available on windows only) .
f=readcommtofile(CommPort,FileName[,[READ[RESET]]Timeout])
CommPort - comm port number eg COM1
Filename - name of file to read to
Timeout - if nothing read after Timeout millisecs then
stopreadcommtofile is automatically executed - set to zero (0) for no
timeout (default)
If preceded by the chars "READ" (do not include quotes) the entire read
function timesout after Timeout Millisecs,
otherwise it waits for an initial response within Timeout Millisecs
If "READ" is followed by the chars "RESET" (do not include quotes) eg
"READRESET" the timeout starts from the last character read in, else the
timeout starts from the first character read in.
e.g. if Timeout="READ60000" the function will return after 1 minute
regardless of how many chars are read in. If Timeout="60000" the
function will return after 1 minute if no chars have been read but will
not timeout if chars have been read in the first minute.
If a timeout occurs the string "\r\nTIMEOUT\r\n" is appended to the file
The Comm Port must be opened with the opencommport function.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 180. stopreadcommtofile ΓòÉΓòÉΓòÉ
stopreadcommtofile
Stop Read from Comm Port to file (available on windows only) .
f=stopreadcommtofile(CommPort)
CommPort - comm port number eg COM1
The Comm Port must be opened with the opencommport function.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 181. writecommfromfile ΓòÉΓòÉΓòÉ
writecommfromfile
Write from file to Comm Port (available on windows only) .
f=writecommfromfile(CommPort,FileName[,WriteTimeout])
CommPort - comm port number eg COM1
Filename - name of file to write from
WriteTimeout - if nothing written after Timeout millisecs then return -
set to zero (0) for no timeout (default)
The Comm Port must be opened with the opencommport function.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 182. writewaitreplycomm ΓòÉΓòÉΓòÉ
writewaitreplycomm
Write to Comm Port. and wait for reply (available on windows only).
nobyteswritten=writewaitreplycomm(CommPort,String,FileName,ReplyLength[,[READ[RESET]]Timeout[WRITEWriteTimeout],[StartChar,EndChar]])
CommPort - comm port number eg COM1
String - string to write to the comm port
Filename - name of file to place reply in
ReplyLength - length of reply - Zero (0) means unknown length and
StartChar and EndChar must be given
Timeout - if nothing read after Timeout millisecs then return - set to
zero (0) for no timeout (default)
If preceded by the chars "READ" (do not include quotes) the entire read
function timesout after Timeout Millisecs,
otherwise it waits for an initial response within Timeout Millisecs
If "READ" is followed by the chars "RESET" (do not include quotes) eg
"READRESET" the timeout starts from the last character read in, else the
timeout starts from the first character read in.
e.g. if Timeout="READ60000" the function will return after 1 minute
regardless of how many chars are read in. If Timeout="60000" the
function will return after 1 minute if no chars have been read but will
not timeout if chars have been read in the first minute.
WriteTimeout - if nothing written after WriteTimeout millisecs then
return - set to zero (0) for no timeout (default). The read timeout must
be followed by the chars "WRITE" (do not include quotes) and then the
WriteTimeout
eg "READRESET1000WRITE500"
StartChar - 1st char in the reply - if not Zero (0) writewaitreplycomm
waits for this char to start the reply - ReplyLength must be Zero (0)
Must be a single char or the decimal representation of the char using
more than one char.
eg the char '1' can also be entered as '49'
eg decimal 2 must be entered as '02' (more than one char)
EndChar - last char in the reply - ReplyLength must be Zero (0)
Must be a single char or the decimal representation of the char using
more than one char.
eg the char '1' can also be entered as '49'
eg decimal 2 must be entered as '02' (more than one char)
The Comm Port must be opened with the opencommport function.
Returns no of bytes written.
RESULT.TIMEOUT - 0 if no timeout - 1 if timeout occured
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 183. clearcommbuffer ΓòÉΓòÉΓòÉ
clearcommbuffer
Flushes the transmit buffer (available on windows only).
f=clearcommbuffer(CommPort)
CommPort - comm port number eg COM1
The Comm Port must be opened with the opencommport function.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 10 Comms Functions.
ΓòÉΓòÉΓòÉ 184. Section 11 Event Functions ΓòÉΓòÉΓòÉ
Section 11 - Event Functions
whenwinchildsettitle* When window with title/child
created/visible/invisible/destroyed then set window title.
whenwinchildrunscript* When window with title/child
created/visible/invisible/destroyed then run script.
whenfilerunscript* When file created/changed/destroyed then run
script.
whendirrunscript* When directory created/changed/destroyed then run
script.
Contents.
ΓòÉΓòÉΓòÉ 185. whenwinchildsettitle ΓòÉΓòÉΓòÉ
whenwinchildsettitle
When window with title/child created/visible/invisible/destroyed then
set window title.
f=whenwinchildsettitle(Title,ChildText,EventType,NewTitle)
Title - title of window to wait for
ChildText - text of child window - ignored if NULL ("")
EventType - can be one of "CREATED" "VISIBLE" "INVISIBLE" "DESTROYED" -
default VISIBLE
NewTitle - new title
This function returns immediately and runs in background waiting for a
window with title that contains child with text to be created and then
sets the new title.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 11 Event Functions.
ΓòÉΓòÉΓòÉ 186. whenwinchildrunscript ΓòÉΓòÉΓòÉ
whenwinchildrunscript
When window with title/child created/visible/invisible/destroyed then
run script.
f=whenwinchildrunscript(Title,ChildText,EventType,Action)
Title - title of window to wait for
ChildText - text of child window - ignored if NULL ("")
EventType - can be one of "CREATED" "VISIBLE" "INVISIBLE" "DESTROYED" -
default VISIBLE
Action - can be 1) a Maid File or 2) a RexxScript file with arguments
or 3) Text containing REXX commands.
Maid File - the name or a Maid dialog to run
eg
f=whenwinchildrunscript("MyTitle","MyChild","VISIBLE","C:\MAID\EXAMPLES\EX01.MDE")
RexxScript with arguments -
RexxScript[,Argument0][,Argument1]...[,ArgumentN]
RexxScript - file name of Rexx script to run
Argument0 - optional argument 0
Argument1 - optional argument 1
ArgumentN - optional argument N
eg
f=whenwinchildrunscript("MyTitle","MyChild","VISIBLE","C:\MAID\EXAMPLES\TRYME.REX")
Text containing REXX commands
eg
f=whenwinchildrunscript("MyTitle","MyChild","VISIBLE",'f=MaidStartDialog("C:\MAID\EXAMPLES\EX01.MDE")')
This function returns immediately and runs in background waiting for
the window with EventType and then runs the specified script.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 11 Event Functions.
ΓòÉΓòÉΓòÉ 187. whenfilerunscript ΓòÉΓòÉΓòÉ
whenfilerunscript
When file created/changed/destroyed then run script.
f=whenfilerunscript(Filename,EventType,Action)
Filename - name of file
EventType - can be one of "CREATED" "CHANGED" "DESTROYED" - default
CHANGED
Action - can be 1) a Maid File or 2) a RexxScript file with arguments
or 3) Text containing REXX commands.
Maid File - the name or a Maid dialog to run
eg
f=whenfilerunscript("C:\MAID\README.TXT","CHANGED","C:\MAID\EXAMPLES\EX01.MDE")
RexxScript with arguments -
RexxScript[,Argument0][,Argument1]...[,ArgumentN]
RexxScript - file name of Rexx script to run
Argument0 - optional argument 0
Argument1 - optional argument 1
ArgumentN - optional argument N
eg
f=whenfilerunscript("C:\MAID\README.TXT","CHANGED""C:\MAID\EXAMPLES\TRYME.REX")
Text containing REXX commands
eg
f=whenfilerunscript("C:\MAID\README.TXT","CHANGED",'f=MaidStartDialog("C:\MAID\EXAMPLES\EX01.MDE")')
This function returns immediately and runs in background waiting for
the file with EventType and then runs the specified script.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 11 Event Functions.
ΓòÉΓòÉΓòÉ 188. whendirrunscript ΓòÉΓòÉΓòÉ
whendirrunscript
When directory created/changed/destroyed then run script
f=whendirrunscript(Directory,EventType,Action)
Directory - name of directory
EventType - can be one of "CREATED" "CHANGED" "DESTROYED" - default
CHANGED
Action - can be 1) a Maid File or 2) a RexxScript file with arguments
or 3) Text containing REXX commands.
Maid File - the name or a Maid dialog to run
eg f=whendirrunscript("C:\MAID","CHANGED","C:\MAID\EXAMPLES\EX01.MDE")
RexxScript with arguments -
RexxScript[,Argument0][,Argument1]...[,ArgumentN]
RexxScript - file name of Rexx script to run
Argument0 - optional argument 0
Argument1 - optional argument 1
ArgumentN - optional argument N
eg f=whendirrunscript("C:\MAID","CHANGED","C:\MAID\EXAMPLES\TRYME.REX")
Text containing REXX commands
eg
f=whendirrunscript("C:\MAID","CHANGED",'f=MaidStartDialog("C:\MAID\EXAMPLES\EX01.MDE")')
This function returns immediately and runs in background waiting for
the directory with EventType and then runs the specified script.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 11 Event Functions.
ΓòÉΓòÉΓòÉ 189. Section 12 Internet Functions ΓòÉΓòÉΓòÉ
Section 12 - Internet Functions
geturl* Get an internet url page.
geturlheader* Get an internet url page header data.
getfiletags* Get HTML tags from a file.
getfiletext* Get text without tags from a file.
getfilealttext* Get text without tags from a file and include any alt
definitions from the tags.
getnameofhost* Get name of host.
gethostipaddress* Get IP address of host.
geturlipaddress* Get IP address from URL.
geturlstructure* Get an internet url page and the pages referenced
beneath it.
Contents.
ΓòÉΓòÉΓòÉ 190. geturl ΓòÉΓòÉΓòÉ
geturl
Get an internet url page/data (available on windows only).
f=geturl(Filename,URL[,ParameterString[,Timeout]])
Filename - name of file in which to place the result - if NULL "" set
equal to currentdirectory/path/filename specified in the URL - if no
filename specified a temporary file is used - FileName used returned in
RESULT.FILENAME.
URL - URL to get
ParameterString - optional parameter string to specify the type of data
returned. This is typically can be a filename under the URL. It can also
be NULL "".
Timeout - optiinal timeout in seconds - default 60 seconds
If the ParameterString is not specified, this function extracts the
source code of the URL from the internet and places it in the file , else
it returns the type of data requested by the ParameterString.
Any directory paths that do not exist in the filename are created
automatically.
An internet connection must be established prior to this call.
Returns
RESULT.FILEDATA - text strings describing file data
RESULT.FILENAME - name of the file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 191. geturlheader ΓòÉΓòÉΓòÉ
geturlheader
Get an internet url page header data (available on windows only).
f=geturlheader(URL[,ParameterString[,Timeout]])
URL - URL to get
ParameterString - optional parameter string to specify the type of data
returned. This is typically can be a filename under the URL. It can also
be NULL "".
Timeout - optiinal timeout in seconds - default 60 seconds
If the ParameterString is not specified, this function extracts the
source code of the URL from the internet and places it in the file , else
it returns the type of data requested by the ParameterString.
An internet connection must be established prior to this call.
Returns
RESULT.FILEDATA - text strings describing file data
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 192. getfiletags ΓòÉΓòÉΓòÉ
getfiletags
Get HTML tags from a file (available on windows only).
TempFile=getfiletags(Filename)
Filename - name of file.
Returns
RESULT.FILENAME - name of the TempFile
TempFile containing all the tags in FileName.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 193. getfiletext ΓòÉΓòÉΓòÉ
getfiletext
Get text without tags from a file (available on windows only).
TempFile=getfiletext(Filename)
Filename - name of file.
Returns
RESULT.FILENAME - name of the TempFile
TempFile containing all the text in FileName without the tags.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 194. getfilealttext ΓòÉΓòÉΓòÉ
getfilealttext
Get text without tags from a file and include any alt definitions from
the tags (available on windows only).
TempFile=getfilealttext(Filename)
Filename - name of file.
Returns
RESULT.FILENAME - name of the TempFile
TempFile containing all the text in FileName without the tags plus any
alt definitions.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 195. getnameofhost ΓòÉΓòÉΓòÉ
getnameofhost
Get name of host (available on windows only).
hostname=getnameofhost()
No Arguments
Returns
hostname - name of the host.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 196. gethostipaddress ΓòÉΓòÉΓòÉ
gethostipaddress
Get IP address of host (available on windows only).
IPaddress=gethostipaddress()
No Arguments
Returns
IPAddress - IP address of the host.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 197. geturlipaddress ΓòÉΓòÉΓòÉ
geturlipaddress
Get IP address from url (available on windows only).
IPaddress=gethostipaddress(URL)
URL - URL to query.
Returns
IPAddress - IP address of the URL.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 198. geturlstructure ΓòÉΓòÉΓòÉ
geturlstructure
Get an internet url page and the pages referenced beneath it (available
on windows only).
f=geturlstructure(Filename,URL[,ParameterString[,Options[,Action]]])
Filename - name of file in which to place the result - must NOT be NULL
"" - FileName used returned in RESULT.FILENAME. A fully qualified path
name can be given in which case the path will be created if it does not
already exist and all pages will be downloaded relative to this path.
If ParameterString is not defined or NULL "" this name would typically
be index.html.
URL - URL to get
ParameterString - optional parameter string to specify the type of data
returned. This is typically can be a filename under the URL. It can also
be NULL "".
Options - optional list of options to control which files (referenced
in the original files or subsequent downloaded files) are downloaded.
"TIMEOUT numseconds" - timeout where numseconds is the timeout in
seconds - default 60 seconds
"RUNBACKGROUND" - return immediately and run download in the background.
If specified an Action is performed when the background download is
completed. If Action is not specified, a Beep is sounded.
"ALLFILES" - downloads all files regardless of the last-modified date
stamp. Cannot be used with UPDATEONLY.
"UPDATEONLY" - only downloads files with a last-modified date stamp
newer than a previous download. Cannot be used with ALLFILES. Default
setting.
If neither ALLFILES nor UPDATEONLY is specified, UPDATEONLY is the
default.
"INCLUDEFILES string1 string2 ... stringN" - only download files whose
names contain the strings string1, string2, up to stringN (seperated by
spaces). Cannot be used with EXCLUDEFILES.
"EXCLUDEFILES string1 string2 ... stringN" - download all files excepy
for files whose names contain the strings string1, string2, up to
stringN. Cannot be used with INCLUDEFILES.
eg "EXCLUDEFILES .zip" download all files except .zip files
"INCLUDEFILES .htm .gif .jpg" only download .htm .gif and .jpg files
"UPDATEONLY" only download files that have been updated since the
last download
"UPDATEONLY EXCLUDEFILES .zip" download all files except .zip files
that have been updated since the last download
"UPDATEONLY INCLUDEFILES .htm .gif .jpg" only download .htm .gif and
.jpg files that have been updated since the last download
"RUNBACKGROUND UPDATEONLY INCLUDEFILES .htm .gif .jpg" only download
.htm .gif and .jpg files that have been updated since the last download -
run in the background.
Action - optional action to perforn when the RUNBACKGROUND task is
completed - can be 1) a Maid File or 2) a RexxScript file with arguments
or 3) Text containing REXX commands. "RUNBACKGROUND" must be specified in
the options.
Maid File - the name or a Maid dialog to run
eg
f=geturlstructure("C:\MySite\index.html","http://www.site.com","","TIMEOUT
30 RUNBACKGROUND INCLUDEFILES .htm","C:\MAID\EXAMPLES\EX01.MDE")
RexxScript with arguments -
RexxScript[,Argument0][,Argument1]...[,ArgumentN]
RexxScript - file name of Rexx script to run
Argument0 - optional argument 0
Argument1 - optional argument 1
ArgumentN - optional argument N
eg
f=geturlstructure("C:\MySite\index.html","http://www.site.com","","RUNBACKGROUND
INCLUDEFILES .htm","C:\MAID\EXAMPLES\TRYME.REX")
Text containing REXX commands
eg
f=geturlstructure("C:\MySite\index.html","http://www.site.com","","RUNBACKGROUND
INCLUDEFILES .htm",'f=MaidStartDialog("C:\MAID\EXAMPLES\EX01.MDE")')
This function returns immediately and runs in background waiting for
the download to complete and then runs the specified script.
If the ParameterString is not specified, this function extracts the
source code of the URL from the internet and places it in the file , else
it returns the type of data requested by the ParameterString.
Any directory paths that do not exist in the filename are created
automatically.
An internet connection must be established prior to this call.
Returns
RESULT.FILEDATA - text strings describing file data
RESULT.FILENAME - name of the file
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 12 Internet Functions.
ΓòÉΓòÉΓòÉ 199. Section 13 Graphic Functions ΓòÉΓòÉΓòÉ
Section 13 - Graphic Functions
opengraphicwindow* Create a graphic window.
closegraphicwindow* Close a graphic window.
drawwinline* Draw a line between two points.
drawwinbox* Draw a box around a point a given distance from the point.
anglearc* Draws a straight line and an arc.
arc* Draws an elliptical arc.
arcto* Draws an elliptical arc and the current position is updated.
getarcdirection* Returns the current arc direction - arc and rectangle
functions use the arc direction.
setarcdirection* Sets the drawing direction to be used for arc and
rectangle functions.
lineto* Draws a line from the current position up to, but not
including, the specified point.
moveto* Updates the current position to the specified point and
optionally returns the previous position.
polybezier* Draws one or more BВzier curves.
polybezierto* Draws one or more BВzier curves and moves the current
position to the ending point of the last BВzier curve.
polydraw* Draws a set of lines and BВzier curves.
polyline* Draws a series of lines by connecting the points specified.
polylineto* Draws one or more lines and moves the current position to
the ending point of the last line.
polypolyline* Draws multiple series of connected lines.
polygon* Draws a polygon consisting of two or more points connected by
straight lines.
polypolygon* Draws a series of closed polygons. The polygons drawn by
this function can overlap.
chord* Draws a chord (a region bounded by the intersection of an
ellipse and a line segment, called a "secant").
ellipse* Draws an ellipse. The center of the ellipse is the center of
the rectangle.
pie* Draws a pie-shaped wedge bounded by the intersection of an
ellipse and two radials.
rectangle* Draws a rectangle.
fillrect* Fills a rectangle with the specified color.
framerect* Draws a border (1 unit thick) around the specified
rectangle with the specified color.
invertrect* Inverts the color in the area within the specified
rectangle.
roundrect* Draws a rectangle with rounded corners.
textout* Writes a character string at the specified location, using
the currently selected font.
drawtext* Draws formatted text in the rectangle.
gettextextent* Computes the width and height of the specified string
of text.
settextcolor* Sets the text color.
gettextcolor* Gets the text color.
listfonts* List available fonts.
settextfont* Sets the text font.
gettextfont* Gets the text font.
setpen* Sets a pen that has the specified style, width, and color.
setbrush* Sets a brush that has the specified color.
setbackgroundcolor* Sets the current background color to the specified
color.
setbackgroundmode* Sets the background mix mode.
setneworigin* Sets the new relative window position of the x,y origin
(0,0).
getbitmapsize* Gets the dimensions of a bitmap file.
exportbitmap* Exports the rectangle as a bitmap file.
importbitmap* Imports a bitmap file into a rectangle.
getnumberoficons* Gets number of icons in a file.
exporticon* Exports the rectangle as an icon file.
importicon* Imports an icon file into a rectangle.
copyrectangle* Copies a rectangle to the clipboard as a bitmap.
pasterectangle* Pastes a bitmap from the clipboard into the specified
rectangle.
getcurrentpos* Gets the current position.
getscrollpos* Gets the current position of the scroll bars.
getscrollrange* Gets the current range of the scrollbars.
setscrollpos* Sets the current scrollbar positions.
updatedisplayon* Sets graphic display on to reflect all drawing in
real time.
updatedisplayoff* Sets graphic display off to freeze the display and
draw in memory.
Contents.
ΓòÉΓòÉΓòÉ 200. opengraphicwindow ΓòÉΓòÉΓòÉ
opengraphicwindow
Create a graphic window (available on windows only).
hwnd=opengraphicwindow(title,stemvariable[,red,green,blue])
title - window title
stemvariable - name Stem Variable to get placement information
Window position.
stemvariable.X - position of top left corner
stemvariable.Y - position of top left corner
stemvariable.CX - width of client area (graphic drawing area)
stemvariable.CY - height of client area (graphic drawing area)
stemvariable.SHOW - "MAXIMIZED" or "MINIMIZED" or "NORMAL" or "HIDDEN"
red - optional background color - amount of red from 0 to 255
green - optional background color - amount of green from 0 to 255
blue - optional background color - amount of blue from 0 to 255
Returns
hwnd - window handle of newly created graphic window.
Default origin is set at position x=0 y=stemvariable.Y ie bottom left
corner of the window
If background color is given then red,green and blue must be specified.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 201. closegraphicwindow ΓòÉΓòÉΓòÉ
closegraphicwindow
Close a graphic window (available on windows only).
f=closegraphicwindow(hwnd)
hwnd - handle of window to close (returned with opengraphicwindow).
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 202. drawwinline ΓòÉΓòÉΓòÉ
drawwinline
Draw a line between two points (available on windows only) .
f=drawwinline(hwnd,x1,y1,x2,y2)
hwnd - handle of window (returned with opengraphicwindow)
x1 - x coordinate of first point
y1 - x coordinate of first point
x2 - x coordinate of second point
y2 - x coordinate of second point
The current position is updated to the end of the line (second point).
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 203. drawwinbox ΓòÉΓòÉΓòÉ
drawwinbox
Draw a box around a point a given distance from the point (available on
windows only) .
f=drawwinbox(hwnd,x1,y1,dist)
hwnd - handle of window (returned with opengraphicwindow)
x1 - x coordinate of point
y1 - x coordinate of point
dist - distance of the edges of the box from the point - minimun 1
pixel
The current position is updated to be the given point.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 204. anglearc ΓòÉΓòÉΓòÉ
anglearc
Draws a straight line and an arc (available on windows NT only) .
f=anglearc(hwnd,x,y,radius,startangle,sweepangle)
hwnd - handle of window (returned with opengraphicwindow)
x - x coordinate of the center of the circle
y - x coordinate of the center of the circle
radius - specifies the radius. This value must be positive
startangle - specifies the start angle, in degrees, relative to the
x-axis
sweepangle - specifies the sweep angle, in degrees, relative to the
starting angle
The straight line is drawn from the current position to the beginning of
the arc. The arc is drawn along the perimeter of a circle of specified
radius with center at x,y. The start and sweep angles define the length
of the arc.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 205. arc ΓòÉΓòÉΓòÉ
arc
Draws an elliptical arc (available on windows only) .
f=arc(hwnd,stemrect,xstartarc,ystartarc,xendarc,yendarc)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
xstartarc - x coordinate of the ending point of the radial line
defining the starting point of the arc
ystartarc - y coordinate of the ending point of the radial line
defining the starting point of the arc
xendarc - x coordinate of the ending point of the radial line defining
the ending point of the arc
yendarc - y coordinate of the ending point of the radial line defining
the ending point of the arc
Stemrect specifies the bounding rectangle. An ellipse formed by the
rectangle defines the curve of the arc. The arc extends in the current
drawing direction from the point where it intersects the radial from the
center of the rectangle to the point xstartarc, ystartarc. The arc ends
where it intersects the radial from the center of the rectangle to the
point xendarc, yendarc. A complete ellipse is drawn if the starting point
and ending point are equal.
The arc is drawn using the current pen and it is not filled and The
current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 206. arcto ΓòÉΓòÉΓòÉ
arcto
Draws an elliptical arc and the current position is updated (available
on windows NT only) .
f=arcto(hwnd,stemrect,xstartarc,ystartarc,xendarc,yendarc)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
xstartarc - x coordinate of the ending point of the radial line
defining the starting point of the arc
ystartarc - y coordinate of the ending point of the radial line
defining the starting point of the arc
xendarc - x coordinate of the ending point of the radial line defining
the ending point of the arc
yendarc - y coordinate of the ending point of the radial line defining
the ending point of the arc
Stemrect specifies the bounding rectangle. An ellipse formed by the
rectangle defines the curve of the arc. The arc extends in the current
drawing direction from the point where it intersects the radial from the
center of the rectangle to the point xstartarc, ystartarc. The arc ends
where it intersects the radial from the center of the rectangle to the
point xendarc, yendarc. A complete ellipse is drawn if the starting point
and ending point are equal.
The arc is drawn using the current pen and it is not filled and the
current position is updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 207. getarcdirection ΓòÉΓòÉΓòÉ
getarcdirection
Returns the current arc direction - arc and rectangle functions use the
arc direction (available on windows only) .
arcdirection=getarcdirection(hwnd)
hwnd - handle of window (returned with opengraphicwindow)
Returns
arcdirection -
"COUNTERCLOCKWISE" - Arcs and rectangles are drawn counterclockwise.
"CLOCKWISE" - Arcs and rectangles are drawn clockwise.window handle of
newly created graphic window.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 208. setarcdirection ΓòÉΓòÉΓòÉ
setarcdirection
Sets the drawing direction to be used for arc and rectangle functions
(available on windows NT only) .
f=setarcdirection(hwnd,arcdirection)
hwnd - handle of window (returned with opengraphicwindow)
arcdirection - "COUNTERCLOCKWISE" - Arcs and rectangles are drawn
counterclockwise."CLOCKWISE" - Arcs and rectangles are drawn clockwise
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 209. lineto ΓòÉΓòÉΓòÉ
lineto
Draws a line from the current position up to, but not including, the
specified point (available on windows only) .
f=lineto(hwnd,x,y)
hwnd - handle of window (returned with opengraphicwindow)
x - x coordinate of the line's end point
y - y coordinate of the line's end point
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 210. moveto ΓòÉΓòÉΓòÉ
moveto
Updates the current position to the specified point and optionally
returns the previous position (available on windows only) .
f=moveto(hwnd,x,y[,stemoldcurrentpos])
hwnd - handle of window (returned with opengraphicwindow)
x - x coordinate of the new position
y - y coordinate of the new position
stemoldcurrentpos - optinal stemname of stem to contain the previour
current position
stemoldcurrentpos.X - old x coordinate
stemoldcurrentpos.Y - old y coordinate
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 211. polybezier ΓòÉΓòÉΓòÉ
polybezier
Draws one or more BВzier curves (available on windows only) .
f=polybezier(hwnd,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoints - stemname of stem containing points
stempoints.0 - number of points
stempoints.1.X - x coordinate of point 1
stempoints.1.Y - y coordinate of point 1
...
stempoints.2.X - x coordinate of point 2
stempoints.2.Y - y coordinate of point 2
stempoints.n.X - x coordinate of point n
stempoints.n.Y - y coordinate of point n
Draws cubic BВzier curves by using the endpoints and control points in
stempoints. The first curve is drawn from the first point to the fourth
point using the second and third points as control points. Subsequent
curves in the sequence need three more points - the ending point of the
previous curve is the starting point, the next two points are control
points, and the third is the ending point.
The number of points (stempoints.0) must be three times the number of
curves to be drawn plus one (an additional starting point).
The figure is not filled. The current pen is used to draws lines. The
current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 212. polybezierto ΓòÉΓòÉΓòÉ
polybezierto
Draws one or more BВzier curves and moves the current position to the
ending point of the last BВzier curve (available on windows only) .
f=polybezierto(hwnd,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoints - stemname of stem containing points
stempoints.0 - number of points
stempoints.1.X - x coordinate of point 1
stempoints.1.Y - y coordinate of point 1
...
stempoints.2.X - x coordinate of point 2
stempoints.2.Y - y coordinate of point 2
stempoints.n.X - x coordinate of point n
stempoints.n.Y - y coordinate of point n
Draws cubic BВzier curves by using the endpoints and control points in
stempoints. The first curve is drawn from the first point to the fourth
point using the second and third points as control points. Subsequent
curves in the sequence need three more points - the ending point of the
previous curve is the starting point, the next two points are control
points, and the third is the ending point.
The number of points (stempoints.0) must be three times the number of
curves to be drawn.
The figure is not filled. The current pen is used to draws lines. The
current position is updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 213. polydraw ΓòÉΓòÉΓòÉ
polydraw
Draws a set of lines and BВzier curves (available on windows NT only) .
f=polydraw(hwnd,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoints - stemname of stem containing points and types (line and
curve identifiers)
stempoints.0 - number of points
stempoints.1.X - x coordinate of point 1
stempoints.1.Y - y coordinate of point 1
stempoints.1.TYPE - type of point 1
...
stempoints.2.X - x coordinate of point 2
stempoints.2.Y - y coordinate of point 2
stempoints.2.TYPE - type of point 2
stempoints.n.X - x coordinate of point n
stempoints.n.Y - y coordinate of point n
stempoints.n.TYPE - type of point n
A points type can be one of the following -
"MOVETO" - this point starts a disjoint figure and becomes the new
current position.
"LINETO" - a line is to be drawn from the current position to this
point, which then becomes the new current position.
"LINETOCLOSEFIGURE" - indicates that the corresponding point is the last
point in a figure and the figure is closed and the current position is
set to the ending point of the closing line.
"BEZIERTO" - this point is a control point or ending point for a BВzier
curve.
These point types always occur in sets of three. The current position
defines the starting point for the curve. The first two points are the
control points with the third point the ending point( becomes the new
current position). There must be three consecutive points.
"BEZIERTOCLOSEFIGURE" - indicates that the corresponding point is the
last point in a figure and the figure is closed. The current position is
set to the ending point of the closing line.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 214. polyline ΓòÉΓòÉΓòÉ
polyline
Draws a series of lines by connecting the points specified (available on
windows only) .
f=polyline(hwnd,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoints - stemname of stem containing points
stempoints.0 - number of points
stempoints.1.x - x coordinate of point 1
stempoints.1.y - y coordinate of point 1
...
stempoints.2.x - x coordinate of point 2
stempoints.2.y - y coordinate of point 2
stempoints.n.x - x coordinate of point n
stempoints.n.y - y coordinate of point n
Lines are drawn from the first point through subsequent points by using
the current pen. The current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 215. polylineto ΓòÉΓòÉΓòÉ
polylineto
Draws one or more lines and moves the current position to the ending
point of the last line (available on windows only) .
f=polylineto(hwnd,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoints - stemname of stem containing points
stempoints.0 - number of points
stempoints.1.x - x coordinate of point 1
stempoints.1.y - y coordinate of point 1
...
stempoints.2.x - x coordinate of point 2
stempoints.2.y - y coordinate of point 2
stempoints.n.x - x coordinate of point n
stempoints.n.y - y coordinate of point n
Lines are drawn from the first point through subsequent points by using
the current pen. The current position is updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 216. polypolyline ΓòÉΓòÉΓòÉ
polypolyline
Draws multiple series of connected lines (available on windows only) .
f=polypolyline(hwnd,stempoly,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoly - stemname of stem containing an array specifying the number
of points in each section. Each entry must be greater than or equal to
two
stempoly.0 - number of line sections
stempoly.1 - number of points in section 1
stempoly.2 - number of points in section 2
...
stempoly.n - number of points in section n
stempoints - stemname of stem containing array of points that contains
the points of the line segments. The sections are specified consecutively
stempoints.1.x - x coordinate of point 1
stempoints.1.y - y coordinate of point 1
...
stempoints.2.x - x coordinate of point 2
stempoints.2.y - y coordinate of point 2
stempoints.t.x - x coordinate of point t
stempoints.t.y - y coordinate of point t
Line segments are drawn by using the current pen. The figures formed by
the segments are not filled and The current position is not used or
updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 217. polygon ΓòÉΓòÉΓòÉ
polygon
Draws a polygon consisting of two or more points connected by straight
lines (available on windows only) .
f=polygon(hwnd,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoints - stemname of stem containing points
stempoints.0 - number of points
stempoints.1.x - x coordinate of point 1
stempoints.1.y - y coordinate of point 1
...
stempoints.2.x - x coordinate of point 2
stempoints.2.y - y coordinate of point 2
stempoints.n.x - x coordinate of point n
stempoints.n.y - y coordinate of point n
The polygon is closed automatically by drawing a line from the last
point to the first and the current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 218. polypolygon ΓòÉΓòÉΓòÉ
polypolygon
Draws a series of closed polygons. The polygons drawn by this function
can overlap (available on windows only) .
f=polypolygon(hwnd,stempoly,stempoints)
hwnd - handle of window (returned with opengraphicwindow)
stempoly - stemname of stem containing an array specifying the number
of points in each polygon . Each entry must be greater than or equal to
two
stempoly.0 - number of polygons
stempoly.1 - number of points in polygon 1
stempoly.2 - number of points in polygon 2
...
stempoly.n - number of points in polygon n
stempoints - stemname of stem containing array of points that contains
the points of the polygons . The polygons are specified consecutively
stempoints.1.x - x coordinate of point 1
stempoints.1.y - y coordinate of point 1
...
stempoints.2.x - x coordinate of point 2
stempoints.2.y - y coordinate of point 2
stempoints.t.x - x coordinate of point t
stempoints.t.y - y coordinate of point t
The current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 219. chord ΓòÉΓòÉΓòÉ
chord
Draws a chord (a region bounded by the intersection of an ellipse and a
line segment, called a "secant") (available on windows only) .
f=chord(hwnd,stemrect,xradial1,yradial1,xradial2,yradial2)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
xradial1 - x coordinate of the endpoint of the radial defining the
starting point of the chord
yradial1 - y coordinate of the endpoint of the radial defining the
starting point of the chord
xradial2 - x coordinate of the endpoint of the radial defining the
ending point of the chord
yradial2 - y coordinate of the endpoint of the radial defining the
ending point of the chord
The curve of the chord is defined by an ellipse that fits the rectangle.
The curve begins at the point where the ellipse intersects the first
radial and extends counterclockwise to the point where the ellipse
intersects the second radial. (A radial is a line drawn from the center
of the ellipse to a specified endpoint on the ellipse.) The chord is
closed by drawing a line from the intersection of the first radial and
the curve to the intersection of the second radial and the curve.
A complete ellipse is drawn if the starting point and ending point of
the curve are equal, .
The current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 220. ellipse ΓòÉΓòÉΓòÉ
ellipse
Draws an ellipse. The center of the ellipse is the center of the
rectangle (available on windows only) .
f=ellipse(hwnd,stemrect,)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
The current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 221. pie ΓòÉΓòÉΓòÉ
pie
Draws a pie-shaped wedge bounded by the intersection of an ellipse and
two radials (available on windows only) .
f=pie(hwnd,stemrect,xradial1,yradial1,xradial2,yradial2)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x-coordinate of rectangle
stemrect.Y - y-coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
xradial1 - x coordinate of the endpoint of the first radial
yradial1 - y coordinate of the endpoint of the first radial
xradial2 - x coordinate of the endpoint of the second radial
yradial2 - y coordinate of the endpoint of the second radial
The curve of the pie is defined by an ellipse that fits the rectangle.
The curve begins at the point where the ellipse intersects the first
radial and extends counterclockwise to the point where the ellipse
intersects the second radial. (A radial is a line drawn from the center
of the ellipse to the specified endpoint on the ellipse.)
The current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 222. rectangle ΓòÉΓòÉΓòÉ
rectangle
Draws a rectangle (available on windows only) .
f=rectangle(hwnd,stemrect)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
The current position is not used or updated.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 223. fillrect ΓòÉΓòÉΓòÉ
fillrect
Fills a rectangle with the specified color (available on windows only) .
f=fillrect(hwnd,stemrect,red,green,blue)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
red - amount of red from 0 to 255
green - amount of green from 0 to 255
blue - amount of blue from 0 to 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 224. framerect ΓòÉΓòÉΓòÉ
framerect
Draws a border (1 unit thick) around the specified rectangle with the
specified color (available on windows only) .
f=framerect(hwnd,stemrect,red,green,blue)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
red - amount of red from 0 to 255
green - amount of green from 0 to 255
blue - amount of blue from 0 to 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 225. invertrect ΓòÉΓòÉΓòÉ
invertrect
Inverts the color in the area within the specified rectangle (available
on windows only) .
f=invertrect(hwnd,stemrect)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 226. roundrect ΓòÉΓòÉΓòÉ
roundrect
Draws a rectangle with rounded corners (available on windows only) .
f=roundrect(hwnd,stemrect,width,height)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
width - width of the ellipse used to draw the rounded corners
height - height of the ellipse used to draw the rounded corners
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 227. textout ΓòÉΓòÉΓòÉ
textout
Writes a character string at the specified location, using the currently
selected font (available on windows only) .
f=textout(hwnd,xstart,ystart,string)
hwnd - handle of window (returned with opengraphicwindow)
xstart - x coordinate of the reference point that Windows uses to align
the string
ystart - y coordinate of the reference point that Windows uses to align
the string
string - string containing text to write
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 228. drawtext ΓòÉΓòÉΓòÉ
drawtext
Draws formatted text in the rectangle (available on windows only) .
textheight=drawtext(hwnd,string,stemrect,format)
hwnd - handle of window (returned with opengraphicwindow)
string - string containing text to draw
stemrect - stemname of stem containing the rectangle in which the text
is to be formatted
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
format - how to format the string - can be a combination of the
following strings-
"BOTTOM" - bottom-justifies text. Must be combined with "SINGLELINE".
"CALCRECT" - determines the width and height of the rectangle. If there
are multiple lines of text, drawtext uses the width of the rectangle and
extends the base of the rectangle to bound the last line of text. If
there is only one line of text, drawtext modifies the right side of the
rectangle so that it bounds the last character in the line. Stemrect is
updated to fit the formatted text. The text is not drawn.
"CENTER" - centers text horizontally.
"EXTERNALLEADING" - includes the font external leading in line height.
Normally, external leading is not included in the height of a line of
text.
"LEFT" - aligns text to the left.
"NOCLIP" -draws without clipping. Improves function speed.
"NOPREFIX" - turns off processing of prefix characters. Normally,
drawtext interprets the mnemonic-prefix character & as a directive to
underscore the character that follows, and the mnemonic-prefix characters
&& as a directive to print a single &. By specifying "NOPREFIX", this
processing is turned off.
"RIGHT" - aligns text to the right.
"SINGLELINE" - displays text on a single line only. Carriage returns and
linefeeds do not break the line.
"EXPANDTABS" - expands tab characters. The default number of characters
per tab is eight. The Tab character is represented by D2C(9).
"TABSTOP" - sets tab stops. The default number of characters per tab is
eight. If not default specify "TABSTOPn" where n is the number of
characters for each tab.
"TOP" - top-justifies text (single line only).
"VCENTER" - centers text vertically (single line only).
"WORDBREAK" - breaks words. Lines are automatically broken between words
if a word would extend past the edge of the rectangle. A carriage
return-linefeed sequence also breaks the line.
"CALCRECT", "EXTERNALLEADING", "INTERNAL", "NOCLIP", and "NOPREFIX"
strings cannot be used with the "TABSTOP" string.
Strings in the format must be separated by spaces.
eg
textheight=drawtext(hwnd,"bottom",stemrect,"BOTTOM CENTER SINGLELINE")
Returns
textheight - the height of the text
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 229. gettextextent ΓòÉΓòÉΓòÉ
gettextextent
Computes the width and height of the specified string of text (available
on windows only) .
f=gettextextent(hwnd,string,stemextent)
hwnd - handle of window (returned with opengraphicwindow)
string - string to compute
stemextent - stemname of stem containing the results of the extent of
the string
stemextent.CX - width of string
stemextent.CY - height of string
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 230. settextcolor ΓòÉΓòÉΓòÉ
settextcolor
Sets the text color (available on windows only) .
f=settextcolor(hwnd,red,green,blue)
hwnd - handle of window (returned with opengraphicwindow)
red - amount of red from 0 to 255
green - amount of green from 0 to 255
blue - amount of blue from 0 to 255
Black is red 0 green 0 blue 0
White is red 255 green 255 blue 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 231. gettextcolor ΓòÉΓòÉΓòÉ
gettextcolor
Gets the text color (available on windows only) .
f=gettextcolor(hwnd,stemcolor)
hwnd - handle of window (returned with opengraphicwindow)
stemcolor - stemname of stem containing the color results
stemcolor.RED - amount of red between 0 and 255
stemcolor.GREEN - amount of green between 0 and 255
stemcolor.BLUE - amount of blue between 0 and 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 232. listfonts ΓòÉΓòÉΓòÉ
listfonts
List available fonts (available on windows only) .
f=listfonts(hwnd,stemfonts)
hwnd - handle of window (returned with opengraphicwindow)
stemfonts - stemname of stem containing the list of available fonts
stemfonts.0 - number of fonts listed
stemfonts.1 - description of font 1
stemfonts.2 - description of font 2
...
stemfonts.n - description of font n
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 233. settextfont ΓòÉΓòÉΓòÉ
settextfont
Sets the text font (available on windows only) .
f=settextfont(hwnd,stemfont)
hwnd - handle of window (returned with opengraphicwindow)
stemfont - stemname of stem containing the font information
stemfont.FACE - font desciption
stemfont.WEIGHT - font point size
can be "" (Normal) or ONE of
"THIN" "EXTRALIGHT" "LIGHT" "MEDIUM" "SEMIBOLD"
"BOLD" "EXTRABOLD" "HEAVY "
stemfont.STYLE - font style
can be "" (Normal) or a combination of "ITALIC" "UNDERSCORE"
"STRIKEOUT"
stemfont.SIZE - font point size
stemfont.FAMILY - font family
can be "" or ONE of
"MODERN" "ROMAN" "SCRIPT" "HELV" "DECORATIVE"
stemfont.CHARSET - font character set
can be "" (Western ANSI - Normal) or ONE of
"SYMBOL" "JAPANESE" "HANGEUL" "GB2312" "CHINESE" "OEM/DOS" "JOHAB"
"HEBREW" "ARABIC" "GREEK" "TURKISH" "THAI" "CENTRAL EUROPEAN"
"CYRILLIC"
"MAC" "BALTIC"
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 234. gettextfont ΓòÉΓòÉΓòÉ
gettextfont
Gets the text font (available on windows only) .
f=gettextfont(hwnd,stemfont)
hwnd - handle of window (returned with opengraphicwindow)
stemfont - stemname of stem containing the font information
stemfont.FACE - font desciption
stemfont.WEIGHT - font point size
can be "" (Normal) or ONE of
"THIN" "EXTRALIGHT" "LIGHT" "MEDIUM" "SEMIBOLD"
"BOLD" "EXTRABOLD" "HEAVY "
stemfont.STYLE - font style
can be "" (Normal) or a combination of "ITALIC" "UNDERSCORE"
"STRIKEOUT"
stemfont.SIZE - font point size
stemfont.FAMILY - font family
can be "" or ONE of
"MODERN" "ROMAN" "SCRIPT" "HELV" "DECORATIVE"
stemfont.CHARSET - font character set
can be "" (Western ANSI - Normal) or ONE of
"SYMBOL" "JAPANESE" "HANGEUL" "GB2312" "CHINESE" "OEM/DOS" "JOHAB"
"HEBREW" "ARABIC" "GREEK" "TURKISH" "THAI" "CENTRAL EUROPEAN"
"CYRILLIC"
"MAC" "BALTIC"
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 235. setpen ΓòÉΓòÉΓòÉ
setpen
Sets a pen that has the specified style, width, and color (available on
windows only) .
f=setpen(hwnd,style,width,red,green,blue)
hwnd - handle of window (returned with opengraphicwindow)
style - can be ONE of the following
"SOLID" Pen is solid.
"DASH" Pen is dashed. This style is valid only when the pen width is one
or less in device units.
"DOT " Pen is dotted. This style is valid only when the pen width is one
or less in device units.
"DASHDOT" Pen has alternating dashes and dots. This style is valid only
when the pen width is one or less in device units.
"DASHDOTDOT" Pen has alternating dashes and double dots. This style is
valid only when the pen width is one or less in device units.
"NULL" Pen is invisible.
width - width of the pen
red - amount of red from 0 to 255
green - amount of green from 0 to 255
blue - amount of blue from 0 to 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 236. setbrush ΓòÉΓòÉΓòÉ
setbrush
Sets a brush that has the specified color (available on windows only) .
f=setbrush(hwnd,red,green,blue)
hwnd - handle of window (returned with opengraphicwindow)
red - amount of red from 0 to 255
green - amount of green from 0 to 255
blue - amount of blue from 0 to 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 237. setbackgroundcolor ΓòÉΓòÉΓòÉ
setbackgroundcolor
Sets the current background color to the specified color (available on
windows only) .
f=setbackgroundcolor(hwnd,red,green,blue)
hwnd - handle of window (returned with opengraphicwindow)
red - amount of red from 0 to 255
green - amount of green from 0 to 255
blue - amount of blue from 0 to 255
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 238. setbackgroundmode ΓòÉΓòÉΓòÉ
setbackgroundmode
Sets the background mix mode (available on windows only) .
f=setbackgroundmode(hwnd,mode)
hwnd - handle of window (returned with opengraphicwindow)
mode - can be ONE of the following
"OPAQUE" Background is filled with the current background color before
the text, hatched brush, or pen is drawn.
"TRANSPARENT" Background remains untouched.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 239. setneworigin ΓòÉΓòÉΓòÉ
setneworigin
Sets the new relative window position of the x,y origin (0,0) (available
on windows only) .
f=setneworigin(hwnd,x,y)
hwnd - handle of window (returned with opengraphicwindow)
x - x-coordinate of the new origin
y - y-coordinate of the new origin
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 240. getbitmapsize ΓòÉΓòÉΓòÉ
getbitmapsize
Gets the dimensions of a bitmap file (available on windows only) .
f=getbitmapsize(filename,stemsize)
filename - file name of the bitmap
stemsize - stemname of stem containing the size of the bitmap on return
stemsize.CX - width of bitmap
stemsize.CY - height of bitmap
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 241. exportbitmap ΓòÉΓòÉΓòÉ
exportbitmap
Exports the rectangle as a bitmap file (available on windows only) .
f=exportbitmap(hwnd,stemrect,filename[,newwidth,newheight][,vga])
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
filename - file name that will contain the exported bitmap
newwidth - optional - new width for the bitmap - default stemrect.CX -
width of rectangle
newheight - optinal - new height for the bitmap - default stemrect.CY -
height of rectangle
vga - optional - can only be "VGA" - if specified a 16 color bitmap is
produced
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 242. importbitmap ΓòÉΓòÉΓòÉ
importbitmap
Imports a bitmap file into a rectangle (available on windows only) .
f=importbitmap(hwnd,stemrect,filename[,importtype])
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle - if zero ( 0 ) defaults to the width
of the bitmap
stemrect.CY - height of rectangle - if zero ( 0 ) defaults to the height
of the bitmap
filename - file name of the bitmap to import
importtype - optional - can be "STRETCH" or "COPY" - default stretch
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 243. getnumberoficons ΓòÉΓòÉΓòÉ
getnumberoficons
Gets number of icons in a file (available on windows only) .
noicons=getnumberoficons(filename)
filename - file name that contains icons
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 244. exporticon ΓòÉΓòÉΓòÉ
exporticon
Exports the rectangle as an icon file (available on windows only) .
f=exporticon(hwnd,stemrect,filename[,maskred,maskgreen,maskblue])
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
filename - file name that will contain the exported bitmap
maskred - optional - amount of red from 0 to 255
maskgreen - optional - amount of green from 0 to 255
maskblue - optional - amount of blue from 0 to 255
If maskred,maskgreen,maskblue is specified the mask color is transparent
in the icon produced.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 245. importicon ΓòÉΓòÉΓòÉ
importicon
Imports an icon file into a rectangle (available on windows only) .
f=importicon(hwnd,stemrect,filename[,importtype][,iconindex])
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle - if zero ( 0 ) defaults to the width
of the icon
stemrect.CY - height of rectangle - if zero ( 0 ) defaults to the height
of the icon
filename - file name of the icon to import - can be an .ico, .exe or
.dll file
importtype - optional - can be "STRETCH" or "COPY" - default stretch
iconindex - optional - index of icon to extract - default 0
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 246. copyrectangle ΓòÉΓòÉΓòÉ
copyrectangle
Copies a rectangle to the clipboard as a bitmap(available on windows
only) .
f=copyrectangle(hwnd,stemrect[,newwidth,newheight])
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
newwidth - optional - new width for the bitmap - default stemrect.CX -
width of rectangle
newheight - optinal - new height for the bitmap - default stemrect.CY -
height of rectangle
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 247. pasterectangle ΓòÉΓòÉΓòÉ
pasterectangle
Pastes a bitmap from the clipboard into the specified rectangle
(available on windows only) .
f=pasterectangle(hwnd,stemrect)
hwnd - handle of window (returned with opengraphicwindow)
stemrect - stemname of stem containing the rectangle
position/dimensions
stemrect.X - x coordinate of rectangle
stemrect.Y - y coordinate of rectangle
stemrect.CX - width of rectangle
stemrect.CY - height of rectangle
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 248. getcurrentpos ΓòÉΓòÉΓòÉ
getcurrentpos
Gets the current position (available on windows only) .
f=getcurrentpos(hwnd,stempos)
hwnd - handle of window (returned with opengraphicwindow)
stempos - stemname of stem to return the current position
stempos.X - x coordinate of current position
stempos.Y - y coordinate of current position
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 249. getscrollpos ΓòÉΓòÉΓòÉ
getscrollpos
Gets the current position of the scroll bars (available on windows only)
.
f=getscrollpos(hwnd,scrollpos)
hwnd - handle of window (returned with opengraphicwindow)
scrollpos - stemname of stem to return the current position of the
scrollbars
Returns
scrollpos.X - position of the horizontal scrollbar
scrollpos.Y - position of the vertical scrollbar
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 250. getscrollrange ΓòÉΓòÉΓòÉ
getscrollrange
Gets the current range of the scrollbars (available on windows only) .
f=getscrollrange(hwnd,scrollrange)
hwnd - handle of window (returned with opengraphicwindow)
scrollrange - stemname of stem to return the current range of the
scrollbars
Returns
scrollrange.MINX - min range of the horizontal scrollbar
scrollrange.MINY - min range of the vertical scrollbar
scrollrange.MAXX - max range of the horizontal scrollbar
scrollrange.MAXY - max range of the vertical scrollbar
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 251. setscrollpos ΓòÉΓòÉΓòÉ
setscrollpos
Sets the current scrollbar positions (available on windows only) .
f=setscrollpos(hwnd,scrollpos)
hwnd - handle of window (returned with opengraphicwindow)
scrollpos - stemname of stem with the current position of the
scrollbars
scrollpos.X - position of the horizontal scrollbar
scrollpos.Y - position of the vertical scrollbar
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 252. updatedisplayon ΓòÉΓòÉΓòÉ
updatedisplayon
Sets graphic display on to reflect all drawing in real time .
f=updatedisplayon(hwnd)
hwnd - handle of window (returned with opengraphicwindow)
This is the default for a window created with opengraphicwindow.
Any graphics drawn in memory after an updatedisplayoff command will be
refreshed to the window.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 253. updatedisplayoff ΓòÉΓòÉΓòÉ
updatedisplayoff
Sets graphic display off to freeze the display and draw in memory.
f=updatedisplayoff(hwnd)
hwnd - handle of window (returned with opengraphicwindow)
Any graphics drawn after this command will be drawn in memory. After an
updatedisplayon command the graphics will be refreshed to the window.
This function requires a licensed copy of "Modular And Integrated
Design" to be installed.
Contents.
Section 13 Graphic Functions.
ΓòÉΓòÉΓòÉ 254. Version Notice ΓòÉΓòÉΓòÉ
Version Notice
REXXIO
Version 4.6
LesTec Pty Ltd
P O Box 1394
Dee Why
NSW 2099
AUSTRALIA
Web Address - http://www.lestec.com.au
(c) Copyright LesTec Pty Limited 1998-2000. All Rights Reserved.
A.C.N. 003 996 978
ΓòÉΓòÉΓòÉ <hidden> No Title for this topic ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Contents
A list of all Help topics available for REXXIO . For information on how
to use Help, press F1