AWeb ARexx Commands

Inquiry commands

GET (general)
GET ACTIVEPORT
GET CACHE
GET CLIP
GET FOCUS
GET FRAMES

GET FRAMESET
GET HOTLIST
GET IMAGES
GET INFO
GET LINKS
GET MIME

GET NAMES
GET PORT
GET SCREEN
GET SELECTION
GET SOURCE
GET TITLE

GET URL
GET VERSION
GET WINDOW
GET WINDOWS

GET

Template:


   GET ITEM/A,TARGET/K,VAR/K,STEM/K,ALL/S

Obtain various kinds of information about the program or the document in the addressed window or in the specified frame.

Argument Description
ITEM Specifies the kind of information to obtain. See above for a list of all valid item names.
TARGET The target name of the window or frame to obtain information from.
VAR The name of a variable to return the information in. If no name is specified, the single valued result will be returned in the reserved ARexx variable RESULT.
STEM The name of a stem variable to return an array of structured information in. Do not include the trailing period in this name.
ALL The meaning of this switch depends on the ITEM obtained.
Not all arguments are valid for all ITEM values. Refer to the individual descriptions for the template containing all valid arguments.

Argument	Description
ITEM	Specifies the kind of information to obtain. See above for a list of all valid item names.
TARGET	The target name of the window or frame to obtain information from.
VAR	The name of a variable to return the information in. If no name is specified, the single valued result will be returned in the reserved ARexx variable `RESULT`.
STEM	The name of a stem variable to return an array of structured information in. Do not include the trailing period in this name.
ALL	The meaning of this switch depends on the ITEM obtained.

GET ACTIVEPORT

Template:


   GET ACTIVEPORT  VAR/K

Obtain the name of the ARexx port associated with the most recently activated AWeb window. Useful in ARexx macros started via a shell script or shell command to find the active window.

GET CACHE

Template:


   GET CACHE  STEM/K

Obtain details of the files currently residing in AWeb's disk cache.

Structured information components
Name Description
URL The URL for the cached file.
TYPE The MIME type of the cached file.
SIZE The size in bytes of the cached file.
DATE The date that this file was retrieved, in internal system days (like returned by the DATE('I') command).
FILE The full path and file name of the cached copy.
IMPORTANT: Never delete or modify these files other than via AWeb ARexx commands!

Structured information components
Name	Description
URL	The URL for the cached file.
TYPE	The MIME type of the cached file.
SIZE	The size in bytes of the cached file.
DATE	The date that this file was retrieved, in internal system days (like returned by the `DATE('I')` command).
FILE	The full path and file name of the cached copy. IMPORTANT: Never delete or modify these files other than via AWeb ARexx commands!

GET CLIP

Template:


   GET CLIP  VAR/K

Obtain the current contents of the clipboard. Due to various internal limitations, a maximum of 8192 characters is returned.

GET FOCUS

Template:


   GET FOCUS  VAR/K

Obtain the frame ID of the frame that currently has the keyboard scroll focus. If the main window has the focus, an empty string will be returned.

GET FRAMES

Template:


   GET FRAMES  TARGET/K,STEM/A/K,ALL/S

Obtain an array with the names and IDs of all frames directly subordinate to the command's target window or frame. If the ALL switch is set, also details of all nested frames are returned.

Structured information components
Name Description
ID A unique (within the addressed window) identification for the frame. Frames do not necessarily have a name, but will always have an ID. The ID is recognized by the leading # sign, and can be used in TARGET ARexx arguments.
Note that this ID can not be used in HTML TARGET attributes.
NAME Name of the frame, as defined by the NAME attribute in the <FRAME> HTML tag.
TITLE The title of the document loaded in the frame. If the document has no title defined, the URL of this document is returned.
URL The URL of the document loaded in the frame.

Structured information components
Name	Description
ID	A unique (within the addressed window) identification for the frame. Frames do not necessarily have a name, but will always have an ID. The ID is recognized by the leading `#` sign, and can be used in `TARGET` ARexx arguments. Note that this ID can not be used in HTML `TARGET` attributes.
NAME	Name of the frame, as defined by the NAME attribute in the <FRAME> HTML tag.
TITLE	The title of the document loaded in the frame. If the document has no title defined, the URL of this document is returned.
URL	The URL of the document loaded in the frame.

GET FRAMESET

Template:


   GET FRAMESET  TARGET/K,VAR/K

Obtain a boolean value specifying if the document in the target window or frame is a frameset document. If the document is a frameset document, "1" is returned. If the document is a normal document, "0" is returned. Note that normal documents still can contain inlined frames (<IFRAME>).

GET HOTLIST

Template:


   GET HOTLIST  STEM/A/K

Obtain an array with all entries of AWeb's hotlist.

Structured information components
Name Description
GROUP "1" if this array element defines a group, or "0" if this array element defines a single entry.
TITLE Title of the group or entry, as shown in the hotlist.
URL URL of this entry. Only defined for single entries, not for groups.
OWNER The array index number for the group that is the direct owner of this array element. This will be 0 if this element has no owner (it is a root level group, or an unassigned entry).

Structured information components
Name	Description
GROUP	"1" if this array element defines a group, or "0" if this array element defines a single entry.
TITLE	Title of the group or entry, as shown in the hotlist.
URL	URL of this entry. Only defined for single entries, not for groups.
OWNER	The array index number for the group that is the direct owner of this array element. This will be 0 if this element has no owner (it is a root level group, or an unassigned entry).

GET IMAGES

Template:


   GET IMAGES  TARGET/K,STEM/A/K

Obtain an array with information of all embedded images in the HTML document in the addressed window or the specified frame.

Structured information components
Name Description
ALT The ALT text for this image, if any.
TYPE The type of image. This will be one of the following:

BACKGROUND The document's background image.
IMAGE Not any of the other, special images.
ISMAP A server side image map.
USEMAP A client side image map.

URL The URL for the image.

GET INFO

Template:


   GET INFO  TARGET/K,STEM/A/K

Obtain HTTP headers and <META> and <LINK> information from the document in the addressed window or the specified frame.

Structured information components
Name Description
TYPE Type of information. This will be one of the following:

CACHE The document was read from AWebs cache. The VALUE component will contain "1".
HTTP HTTP transfer header.
META HTML <META> information.
LINK An HTML <LINK> anchor.

VALUE Depending on the returned TYPE: the HTTP header, the META name and contents, or the LINK title.
URL The URL linked to. Only present if TYPE equals "LINK".

GET LINKS

Template:


   GET LINKS  TARGET/K,STEM/A/K

Obtain an array with information of all hyperlinks in the HTML document in the addressed window or the specified frame.

Structured information components
Name Description
TARGET The target frame name, as defined in the TARGET HTML attribute.
URL The URL this link points to.

Structured information components
Name	Description
TARGET	The target frame name, as defined in the `TARGET` HTML attribute.
URL	The URL this link points to.

GET MIME

Template:


   GET MIME  TARGET/K,VAR/K

Obtain the MIME content type of the document currently displayed in the addressed window or the specified frame.

GET NAMES

Template:


   GET NAMES  TARGET/K,STEM/A/K

Obtain an array with all fragment names (defined by <A NAME="name">) in the HTML document in the addressed window or the specified frame.

Structured information components
Name Description
NAME The fragment name.

Structured information components
Name	Description
NAME	The fragment name.

GET PORT

Template:


   GET PORT  TARGET/K

Obtain the ARexx portname for the window that contains the frame with the specified name.

GET SCREEN

Template:


   GET SCREEN  VAR/K

Obtain the name of the public screen that AWeb uses to open its windows on.

GET SELECTION

Template:


   GET SELECTION  VAR/K

Obtain the currently selected text.

Note that due to an ARexx limitation, only the first 65535 bytes are returned.

GET SOURCE

Template:


   GET SOURCE  TARGET/K,VAR/K

Obtain the source code of the document currently displayed in the addressed window or the specified frame.

Note that due to an ARexx limitation, only the first 65535 bytes are returned.

GET TITLE

Template:


   GET TITLE  TARGET/K,VAR/K

Obtain the title of the document currently displayed in the addressed window or the specified frame. If the document has no title defined, the URL of this document is returned.

GET URL

Template:


   GET URL  TARGET/K,VAR/K

Obtain the URL of the document currently displayed in the addressed window or the specified frame.

GET VERSION

Template:


   GET VERSION  VAR/K

Obtain the version of AWeb. The string returned starts with numeric "version.revision".

GET WINDOW

Template:


   GET WINDOW  VAR/K

Obtain the rectangle describing the location and size of the addressed window.

GET WINDOWS

Template:


   GET WINDOWS  STEM/A/K

Obtain an array with details of all open AWeb windows.

Structured information components
Name Description
PORT The name of the ARexx port of the window.
RECT A rectangle describing the location and size of the window.
ZOOMED If the window is in zoomed state, this contains "1", else this contains "0".

Name	Description
PORT	The name of the ARexx port of the window.
RECT	A rectangle describing the location and size of the window.
ZOOMED	If the window is in zoomed state, this contains "1", else this contains "0".