AmigaOS Manual: ARexx Functions - Revision history

Janne Peräaho: Clarified DATE() usage (hopefully) and updated the examples.

2022-06-02T08:53:56Z

Clarified DATE() usage (hopefully) and updated the examples.

← Older revision		Revision as of 08:53, 2 June 2022
Line 444:		Line 444:
	<nowiki>DATE([option][,date][,format])</nowiki>		<nowiki>DATE([option][,date][,format])</nowiki>

	Returns the current date in the ~~specified~~ format. ~~The~~ ~~default~~ ('~~NORMAL~~') option ~~returns~~ ~~the~~ ~~date~~ in ~~the~~ ~~form~~ DD ~~MMM~~ ~~YYYY,~~ as in ~~20 APR 1988. The~~ ~~options~~ ~~recognized~~ ~~are~~:		Returns the current date in the format of specified by ''option''. The following option strings (of which only the first letter is needed) may be supplied:

	; BASEDATE		; BASEDATE
Line 450:		Line 450:

	; CENTURY		; CENTURY
	: The number of days since January 1 of the century		: The number of days since January 1 of the current century

	; DAYS		; DAYS
Line 482:		Line 482:
	: The day of the week (in mixed case)		: The day of the week (in mixed case)

			If ''option'' is omitted, it defaults to 'NORMAL'.
	These options can be shortened to just the first character.

			If ''date'' is specified, DATE() will use that date instead of the computer's current date in its calculations. If ''format'' is not specified, then ''date'' is assumed to be in system (internal) days. If specified, ''format'' can be either 'I' if ''date'' is in internal format, or 'S' if ''date'' is in sorted (YYYYMMDD) format.
	The DATE() function also accepts optional second and third arguments to supply the date either in the form of internal system days or in the 'sorted' form YYYYMMDD. The second argument is specifying either system days (the default) or a sorted date. The third argument specifies the form of the date and can be either 'I' or 'S'. The current date in system days can be retrieved using DATE('INTERNAL'). For example:

			Examples:

	<syntaxhighlight lang="rexx">		<syntaxhighlight lang="rexx">
	SAY DATE() -> ~~14 Jul 1992~~		SAY DATE( 'I' ) -> 16223
	SAY DATE( ~~'M'~~ ) -> ~~July~~		SAY DATE() -> 02 Jun 2022
	SAY DATE( S ) -> ~~19920714~~		SAY DATE( 'M' ) -> June
	SAY DATE( 'S~~', DATE( 'I' ) + 21~~ ) -> ~~19920804~~		SAY DATE( S ) -> 20220602
			SAY DATE( 'S', DATE( 'I' ) + 21 ) -> 20220623
	SAY DATE( 'W', 19890609, 'S' ) -> Friday		SAY DATE( 'W', 19890609, 'S' ) -> Friday
	</syntaxhighlight>		</syntaxhighlight>

Janne Peräaho: /* DATE() */

2022-06-02T08:27:28Z

DATE()

← Older revision		Revision as of 08:27, 2 June 2022
Line 442:		Line 442:
	=== DATE() ===		=== DATE() ===

	<nowiki>DATE([option][,date][format])</nowiki>		<nowiki>DATE([option][,date][,format])</nowiki>

	Returns the current date in the specified format. The default ('NORMAL') option returns the date in the form DD MMM YYYY, as in 20 APR 1988. The options recognized are:		Returns the current date in the specified format. The default ('NORMAL') option returns the date in the form DD MMM YYYY, as in 20 APR 1988. The options recognized are:

Tony Wyatt: Added [] around "digits" in X2D()

2021-10-18T03:06:15Z

Added [] around "digits" in X2D()

← Older revision		Revision as of 03:06, 18 October 2021
Line 1,223:		Line 1,223:
	=== X2D() ===		=== X2D() ===

	<nowiki>X2D(hex,digits)</nowiki>		<nowiki>X2D(hex[,digits])</nowiki>

	Converts a hexadecimal number to decimal. For example:		Converts a hexadecimal number to decimal. For example:

Janne Peräaho: Added SETCLIP and GETCLIP links

2019-04-21T23:06:01Z

Added SETCLIP and GETCLIP links

← Older revision		Revision as of 23:06, 21 April 2019
Line 98:		Line 98:
	The Clip List is a publicly accessible mechanism that can be used as a general clipboard for intertask communication. Many functions use the clipboard for retrieving different types of information, such as predefined constants or strings.		The Clip List is a publicly accessible mechanism that can be used as a general clipboard for intertask communication. Many functions use the clipboard for retrieving different types of information, such as predefined constants or strings.

	The Clip List maintains a set of (name, value) pairs that may be used for a variety of purposes. (SETCLIP() is used to add pairs to the list.) Each entry in the list consists of a name and a value string and may be located by name. In general, the names used should be chosen to be unique to an application to prevent unintended duplications with other programs. Any number of entries may be posted to the list.		The Clip List maintains a set of (name, value) pairs that may be used for a variety of purposes. ([[AmigaOS_Manual:_ARexx_Functions#SETCLIP.28.29\|SETCLIP()]] is used to add pairs to the list.) Each entry in the list consists of a name and a value string and may be located by name. In general, the names used should be chosen to be unique to an application to prevent unintended duplications with other programs. Any number of entries may be posted to the list.

	One potential application for the Clip List is as a mechanism for loading predefined constants into an ARexx program. For example:		One potential application for the Clip List is as a mechanism for loading predefined constants into an ARexx program. For example:
Line 104:		Line 104:
	pi=3.14159; e=2.718; sqrt2=1.414 . . .		pi=3.14159; e=2.718; sqrt2=1.414 . . .

	(i.e., a series of assignments separated by semicolons). In use, such a string could be retrieved by name using the built-in function GETCLIP() and then INTERPRETed within the program. The assignment statements within the string would then create the required constant definitions. For example:		(i.e., a series of assignments separated by semicolons). In use, such a string could be retrieved by name using the built-in function [[AmigaOS_Manual:_ARexx_Functions#GETCLIP.28.29\|GETCLIP()]] and then INTERPRETed within the program. The assignment statements within the string would then create the required constant definitions. For example:

	<syntaxhighlight lang="rexx">		<syntaxhighlight lang="rexx">

Janne Peräaho at 19:11, 7 April 2019

2019-04-07T19:11:47Z

← Older revision		Revision as of 19:11, 7 April 2019
Line 2,168:		Line 2,168:
	= Notification Function Host Commands =		= Notification Function Host Commands =

	This section provides an alphabetical list of the commands supported by Notification. ~~Before~~ ~~sending~~ ~~commands~~ ~~host~~ ~~address~~ ~~must~~ be ~~set~~ to ~~Notication's~~ ~~message~~ ~~port~~ ~~(NOTIFYA)~~. ~~Below~~ is an ~~example~~ ~~that~~ ~~shows~~ ~~you~~ ~~how~~ to ~~set~~ ~~the~~ ~~host~~ ~~address~~.		This section provides an alphabetical list of the commands supported by Notification. Notification is an [[Application_Library\|application library]] feature for displaying application alerts and notifications for the user. Messages show up on the Workbench screen in boxes which fade away after a time or which should be closed by the user.

			Before sending commands host address must be set to Notication's message port (NOTIFYA). Below is an example that shows you how to set the host address.

	== Program 16. SetHostAddress.rexx ==		== Program 16. SetHostAddress.rexx ==

Janne Peräaho at 18:40, 21 March 2019

2019-03-21T18:40:16Z

← Older revision		Revision as of 18:40, 21 March 2019
Line 2,179:		Line 2,179:
	EXIT 10		EXIT 10
	END		END
	ADDRESS port		ADDRESS VALUE port
	</syntaxhighlight>		</syntaxhighlight>

Janne Peräaho: Added an example program

2019-03-21T12:09:18Z

Added an example program

@@ Line 2,168: / Line 2,168: @@
 = Notification Function Host Commands =
-This section provides an alphabetical list of the Notification function host's commands.
+This section provides an alphabetical list of the commands supported by Notification. Before sending commands host address must be set to Notication's message port (NOTIFYA). Below is an example that shows you how to set the host address.
 == NOTIFY ==

Janne Peräaho at 11:44, 21 March 2019

2019-03-21T11:44:02Z

← Older revision		Revision as of 11:44, 21 March 2019
Line 2,166:		Line 2,166:
	* [[AmigaOS_Manual:_ARexx_Functions#POWER.28.29\|POWER()]]		* [[AmigaOS_Manual:_ARexx_Functions#POWER.28.29\|POWER()]]

	= ~~Notify~~ Function Host Commands =		= Notification Function Host Commands =

	This section provides an alphabetical list of the ~~Notify~~ function host's commands.		This section provides an alphabetical list of the Notification function host's commands.

	== NOTIFY ==		== NOTIFY ==

Janne Peräaho: Added a function host

2019-03-21T11:41:27Z

Added a function host

← Older revision		Revision as of 11:41, 21 March 2019
Line 2,165:		Line 2,165:
	* [[AmigaOS_Manual:_ARexx_Functions#POW.28.29\|POW()]]		* [[AmigaOS_Manual:_ARexx_Functions#POW.28.29\|POW()]]
	* [[AmigaOS_Manual:_ARexx_Functions#POWER.28.29\|POWER()]]		* [[AmigaOS_Manual:_ARexx_Functions#POWER.28.29\|POWER()]]

			= Notify Function Host Commands =

			This section provides an alphabetical list of the Notify function host's commands.

			== NOTIFY ==

			<nowiki>NOTIFY APP/K/A,UPDATE/S,CLOSEONDC/S,PRI/K,SCREEN/K,IMG/K,IMGVALIGN/K/N,LOGONLY/S,TITLE/K,SOUND/K,BACKRXMSG/K,AREXXPORT/K,TEXT/F</nowiki>

			== REGISTERAPP ==

			<nowiki>REGISTERAPP APP/K/A,UPDATE/S,IMG/K,ICON/K,TITLE/K,SOUND/K,TEXT/F</nowiki>

			== UNREGISTERAPP ==

			<nowiki>UNREGISTERAPP APP/K/A</nowiki>

Janne Peräaho: Added link to dos.library's autodoc.

2019-03-20T04:31:02Z

Added link to dos.library's autodoc.

← Older revision		Revision as of 04:31, 20 March 2019
Line 716:		Line 716:
	<nowiki>LINES(file)</nowiki>		<nowiki>LINES(file)</nowiki>

	Returns the number of lines queued or typed ahead at the logical file, which must refer to an interactive stream. The line count is obtained as the secondary result of a WaitForChar() call. For example:		Returns the number of lines queued or typed ahead at the logical file, which must refer to an interactive stream. The line count is obtained as the secondary result of a [http://wiki.amigaos.net/amiga/autodocs/dos.doc.txt dos library's] '''WaitForChar()''' call. For example:

	<syntaxhighlight lang="rexx">		<syntaxhighlight lang="rexx">