Programmer Guide/Macro Library/Kernal/StdLib - Revision history

Jw: /* SectionFile */

2019-01-09T07:13:17Z

SectionFile

← Older revision		Revision as of 09:13, 9 January 2019
Line 335:		Line 335:
	::Result: Always an empty string.		::Result: Always an empty string.

			==FileToolBox==

	{{/FileToolBox}}		{{/FileToolBox}}

Jw: /* FileToolBox */

2019-01-09T07:12:34Z

FileToolBox

← Older revision		Revision as of 09:12, 9 January 2019
Line 337:		Line 337:


	~~==FileToolBox==~~		{{/FileToolBox}}
	~~A toolbox of useful file functions which take paths as parameters, shielding the user from the [[Programmer_Guide~~/~~Shell_Items/File\|file objects]] themselves.~~
	~~===ATTRIBUTE===~~
	~~Get a file's attributes.~~
	~~;usage:~~
	~~:FILETOOLBOX ATTRIBUTE filename attribute~~
	~~;return:~~
	~~:the requested attribute~~
	~~:-1 if the macro failed~~
	~~:-2 if the attribute doesn't exist~~
	~~;note:~~
	~~: all attributes supported by file items are supported by this command. just don't use the exclamation mark !~~
	~~===COMPARE===~~
	~~Simple files comparison.~~
	~~;usage:~~
	~~:FILETOOLBOX COMPARE file1 file2~~
	~~;return:1 if they are different:0 if they are the same:-1 if the macro fails~~
	~~;notes:only the size in bytes is compared at the moment~~
	~~===COPY===~~
	~~Copy a file on disk.~~
	~~;usage: FILETOOLBOX COPY sourcefile targetfile~~
	~~;return: 0 if file was copied:-1 if file was not copied~~

	~~===DELETE===~~
	~~Delete a file from disk.~~
	~~;usage: FILETOOLBOX DELETE filename~~
	~~;return: 0 if file was deleted:-1 if file was not deleted~~
	~~===EXISTS===~~
	~~Test for a file's existence on disk.~~
	~~;usage:~~
	:FileToolBox ~~EXISTS filename~~
	~~;return:~~
	~~:0 if file FileName exists~~
	~~:1 if file FileName does not exist~~
	~~:2 if FileName is a directory~~
	~~===RENAME===~~
	~~Rename a file on disk.~~
	~~;usage: FileToolBox RENAME Source Destination~~
	~~;return: 0 if file was renamed:-1 if file was not renamed~~
	~~===TOKENIZE===~~
	~~Tokenize the file path into drive, directory, name and extension. Note that this '''only''' works if the directory path exists!~~
	~~;usage: FileToolBox TOKENIZE filename [ keyword{drive\|directory\|name\|extension~~} ]
	~~;return: Empty string on failure or 'drive ; directory ; name ; extension' or the part of the filename specified by ''keyword''~~
	~~;example~~
	~~<pre>FileToolBox Tokenize $#file~~
	~~readstr '$result' #drive';'#dir';'#name';'#ext</pre>~~

	==LogWindow==		==LogWindow==

Jw: /* TOKENIZE */

2018-08-14T07:45:03Z

TOKENIZE

← Older revision		Revision as of 09:45, 14 August 2018
Line 380:		Line 380:
	;usage: FileToolBox TOKENIZE filename [ keyword{drive\|directory\|name\|extension} ]		;usage: FileToolBox TOKENIZE filename [ keyword{drive\|directory\|name\|extension} ]
	;return: Empty string on failure or 'drive ; directory ; name ; extension' or the part of the filename specified by ''keyword''		;return: Empty string on failure or 'drive ; directory ; name ; extension' or the part of the filename specified by ''keyword''
			;example
			<pre>FileToolBox Tokenize $#file
			readstr '$result' #drive';'#dir';'#name';'#ext</pre>

	==LogWindow==		==LogWindow==

Jw: /* COPY */

2018-08-07T11:15:56Z

COPY

← Older revision		Revision as of 13:15, 7 August 2018
Line 357:		Line 357:
	===COPY===		===COPY===
	Copy a file on disk.		Copy a file on disk.
	;usage: FILETOOLBOX COPY ~~source target~~		;usage: FILETOOLBOX COPY sourcefile targetfile
	;return: 0 if file was copied:-1 if file was not copied		;return: 0 if file was copied:-1 if file was not copied

	===DELETE===		===DELETE===
	Delete a file from disk.		Delete a file from disk.

Toni: Toni moved page Programmer Guide/Macro Library/StdLib to Programmer Guide/Macro Library/Kernal/StdLib without leaving a redirect

2018-03-07T09:47:06Z

Toni moved page Programmer Guide/Macro Library/StdLib to Programmer Guide/Macro Library/Kernal/StdLib without leaving a redirect

← Older revision	Revision as of 11:47, 7 March 2018
(No difference)

Jw: /* AppHelp */

2018-02-27T07:27:08Z

AppHelp

@@ Line 84: / Line 84: @@
 ==AppHelp==
 This macro implements an interface to the online-help for {{STX}}.
-It is currently '''under development'''.
+===Sub-Commands===
 ==PostMessage==

Jw: /* GetMessage */

2018-02-23T07:50:11Z

GetMessage

← Older revision		Revision as of 09:50, 23 February 2018
Line 225:		Line 225:

	*If the argument <var>noreturn</var> equals 0, all messages which were not processed by a handler, are returned. If it equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code> < 1). Most applications uses the call <code>getmessage 1 1</code> (process secondary queue, return ''never''), to implement the main message loop.		*If the argument <var>noreturn</var> equals 0, all messages which were not processed by a handler, are returned. If it equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code> < 1). Most applications uses the call <code>getmessage 1 1</code> (process secondary queue, return ''never''), to implement the main message loop.
	*The argument <var>queued</var> controls the ~~procesing~~ of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue must be disabled in sub-message loops which queues (unknown) messages by calling the macro [[#MsgQueue\|MSGQUEUE]].		*The argument <var>queued</var> controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue must be disabled in sub-message loops which queues (unknown) messages by calling the macro [[#MsgQueue\|MSGQUEUE]].
	*If the argument <var>nodispatch</var> is set to 1, message dispatching is disabled and all messages are returned to the caller.		*If the argument <var>nodispatch</var> is set to 1, message dispatching is disabled and all messages are returned to the caller.
	*Following special variables and items are used:		*Following special variables and items are used:

Jw: /* Note */

2018-01-18T11:27:31Z

Note

← Older revision		Revision as of 13:27, 18 January 2018
Line 384:		Line 384:
	===Note===		===Note===

	~~works for~~ wave (playback), file, value and table		Works with wave (playback), file, value and table items.

	==CreateMenu==		==CreateMenu==

Jw: /* Description */

2018-01-18T11:27:02Z

Description

← Older revision		Revision as of 13:27, 18 January 2018
Line 372:		Line 372:
	==ShowItem==		==ShowItem==

	~~===Description===~~		Show content of a shell item in a popup dialog.

	Show content of a ~~shellitem~~ in a popup dialog.

	===Usage===		===Usage===

Jw: /* UM and EM */

2018-01-18T11:26:30Z

UM and EM

← Older revision		Revision as of 13:26, 18 January 2018
Line 368:		Line 368:

	EM [ <var>rc</var> [ <var>n</var> ]] ; <var>emsg</var> [; <var>title</var> ]		EM [ <var>rc</var> [ <var>n</var> ]] ; <var>emsg</var> [; <var>title</var> ]
	:Error Message → Display the text "<~~code~~>ERROR (<var>rc</var>): <var>emsg</var> </~~code~~>" in a message box with the caption <var>title</var>. The macro exits from <var>n</var> (default: 2 = exit from caller) and returns the value <var>rc</var>.		:Error Message → Display the text "<samp>ERROR (<var>rc</var>): <var>emsg</var></samp>" in a message box with the caption <var>title</var>. The macro exits from <var>n</var> (default: 2 = exit from caller) and returns the value <var>rc</var>.

	==ShowItem==		==ShowItem==