WarpDoctor Rexx Plug-in Programming Reference

12/27/2002

non-JavaScript version

Commands

- AddToDeleteList Adds a file name to a list of files that are deleted when the plug-in instance terminates.
- AppendFile Appends the contents of one file to another
- CloseMessagePipe Closes an open message pipe.
- CloseWindow Closes an open browser window.
- CopyFile Creates a file to a new name or location on the local hard drive.
- CopyFileToServer Uploads the filename using FTP to the FTP URL specified.
- CreatePage Creates and displays a new HTML page based on the plain text you supply.
- DeleteFile Deletes a local file.
- Drop Drops a single JSVAR variable or all JSVAR variables, or a single or all entries in the RunExclusive list for the current plug-in instance.
- EncodeURL Encodes a URL for non-printable characters; converts a file name to a file type URL.
- ExecProg Executes a program returning the program's return code as the result.
- FileDialog Opens a file dialog box for selecting a file or directory.
- GetCookie Returns the value of a cookie.
- GetFile Gets a file from the web server, transmitting the file as a compressed data stream.
- GetURL Gets a URL to a specified target. URL can be HTTP, FTP, etc. Target can be a browser window or file.
- GotFocus Indicates to the plug-in that the Rexx application has received a mouse click or otherwise gotten a focus message.
- JavaScript Executes JavaScript code.
- Link Establishes a link between the Rexx program and the plug-in, allowing the plug-in to control the Rexx program window, or send messages to the Rexx program.
- MailTo Sends an email. local hard drive.
- MessageBox Displays a messagebox. local hard drive.
- MoveFile Moves a file to a different location on the local hard drive, or renames a file on the local hard drive.
- MoveFileToServer Moves a file from the client to a (FTP) server. local hard drive.
- OpenURL Opens the URL in a new browser window, optionally specifying window parameters such as size, etc.
- OpenWindow Opens the a new browser window - naming the window the name you supply
- PmPrintf Outputs a string to the PmPrintf monitor.
- PostUrl Posts data to a URL, i.e. HTTP POST message. The URL is usually a CGI program that processes information included in the post message.
- Prompt Displays a dialog box with a single text entry control for solicting input from the user.
- Query Returns information from plug-in variables, embed parameters, and information provided by the WD plug-in.
- ReleaseInstance Releases a waiting Rexx program in another instance.
- Reload Reloads the plug-in list in browser, making the browser recognize any newly added plug-ins.
- SayToWin Outputs text in the Rexx output window.
- SayPrompt Outputs text in Rexx output window without a line break.
- SendMessage Sends a user defined message to the message pipe of Rexx program running in another instance.
- Set Sets or changes the value of plug-in variables, and browser features.
- SetCookie Creates or updates a cookie.
- TempFileName Creates a temporary file name.
- WaitOnJS Causes the Rexx program to wait until it is released.

EMBED Tag Parameters

- HTML Standard Parameters called out in the HTML standard that control how the plug-in is presented on the page.
- Plug-in Specific Parameters recognized by the plug-in as having special meaning.

MIME-Types Used by the Rexx Plug-in

- x-warpdoctor/cmdrexx Command line Rexx, or Rexx running in an OS/2 Command Prompt window.
- x-warpdoctor/rexx Rexx program running as a macro of the plug-in. The output is routed to an output window on the HTML page.
- x-warpdoctor/drrexx DrRexx/DrDialog application, running either in its own window or as an applet.
- x-warpdoctor/gpfrexx GPF Rexx application. The application can run either in its own window or as an applet.
- x-warpdoctor/vxrexx VX-Rexx running as a macro of the plug-in. The application runs as an applet.
- x-warpdoctor/vx-rexx VX-Rexx running in a separate session/process. The application can run either in its own window or as an applet.
- x-warpdoctor/generic Generic Rexx or other application.
- x-warpdoctor/execute Used by JavaScript programs to pass variables to a waiting Rexx program.
- x-warpdoctor/warpin WarpIN install package file in the *.WPI format.
- x-warpdoctor/download_gzip Data stream compressed with gzip.
- x-warpdoctor/error Used to return error message by wdPluginCgi.exe when an error is encountered. The error text is in the body of the HTTP message, and is placed in the return value for the wdCommand() function.
- x-warpdoctor/error_12 Error getting *VRW file (VX-Rexx window file) to go with the *.VRM (VX-Rexx macro) file.

Rexx Functions

- wdPluginLoad() Loads (registers) all the other plug-in Rexx functions.
- wdParseArgs() Initializes the plug-in Rexx environment, creates wdMainArgs. and wdEmbed. Rexx stem variables.
- wdCommand() Sends a command to the plug-in.
- wdExposeArgs() Exposes the Rexx stem variables wdMainArgs. and wdEmed. to Rexx functions in separate source files.
- wdOpenPipe() Opens a message pipe
- wdReadPipe() Reads the message pipe
- wdClosePipe() Closes the message pipe
- wdPluginUnload() Unloads (deregisters) all the plug-in Rexx functions.

Rexx Variables

- wdMainArgs. Plug-in area/Rexx application window position, pipe names, type of Rexx program, and instance handle values.
- wdEmbed. Contains user defined parameters to the EMBED HTML tag.
- wdPlugin. Controls error handling in the plug-in Rexx functions.

HTML and JavaScript Files and Functions