Differences between revisions 2 and 32 (spanning 30 versions)
Revision 2 as of 2009-10-20 19:42:00
Size: 1884
Editor: KaiJaeger
Comment:
Revision 32 as of 2017-04-08 06:52:16
Size: 521
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC (Dyalog) = = User Command "GetMsgFrom" =
Line 4: Line 4:
`]GetMsgFrom` translates Windows error codes into a text message if possible.
Line 5: Line 6:
[[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. == Version ==
Line 7: Line 8:
Obviously it makes sense to make ADOCs services available as a User Command. You can download just the script from this page: [[attachment:GetMsgFrom.dyalog]]
Line 9: Line 10:
This page offers a small class script `ADOC` which is designed to do exactly that. This is version 1.0.0 from 2017-04-08.
Line 11: Line 12:
== Assumptions ==

When User Commands got introduced in Dyalog with version 12.1, the User Commands where expected to reside in a sub folder `Salt\Spice` inside the Dyalog installation folder. This means that the script `ADOC.dyalog` attached to this page must go into this directory. Only then the User Commd "ADOC" is recognized.

That script, which represents the ADOC User Command, assumes that there is a sibling folder of `SALT` available named `UserCommands`. Please make sure that the [[ADOC]] script is copied into this folder `UserCommands`. This enables the User Command script to address the real ADOC script as `..\UserCommands\ADOC`.

== Samples ==

Given that the two different ADOC scripts went into the right folders, this would be a sample session:
Example:
Line 22: Line 15:
      ]?ADOC
"??" for general help, "?CMD" for more specific info on command CMD
       ]GetMsgFrom 20
The system cannot find the device specified.
      ]GetMsgFrom 2
The system cannot find the file specified.
Line 25: Line 20:
 Group Name Description
 ===== ==== ===========
 ADOC ADOC.Browse Creates full documentation and displayes it in the default browser
        ADOC.List Prints syntax of all public stuff to the session
Line 30: Line 21:
      ]?ADOC.Browse
Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b=
Script location: ........\SALT\Spice\ADOC
Gathers all sort of information from a class script

      ]?ADOC.List
Command "ADOC.List".
Script location: ........\SALT\Spice\ADOC
Prints a list with all sorts of information to the session

]ADOC.Browse ADOC -b=Opera
Watch your browser
Line 44: Line 23:
Author: KaiJaeger -- KaiJaeger <<DateTime(2017-04-08T06:52:16Z)>>

User Command "GetMsgFrom"

Overview

]GetMsgFrom translates Windows error codes into a text message if possible.

Version

You can download just the script from this page: GetMsgFrom.dyalog

This is version 1.0.0 from 2017-04-08.

Example:

       ]GetMsgFrom 20
The system cannot find the device specified.
      ]GetMsgFrom 2
The system cannot find the file specified.

-- KaiJaeger 2017-04-08 06:52:16


CategoryDyalogUserCommands

UserCommands/GetMsgFrom (last edited 2017-04-08 06:52:16 by KaiJaeger)