Kit commands [Wrappers]

Text


Wrappers are special commands for using dialog requested user
input to replace a special macro within an embedded command
before executing it, for configuration they hijack the program
parameter of the command:

 A B , C , D , E } Commandline } WorkingDir

  A - Wrapper token which is & plus an alphabet character.
  B - The full program parameter of the embedded command.
  C - Wrapper parameter 1
  D - Wrapper parameter 2
  E - Wrapper parameter 3

Put the wrapper only macro REQ within your command where
you want the result, also the environment variable A3C_REQ
stores the result of the last wrapper request.

You cannot embed a wrapper command within another!

Example

  Open a text input box and display result in a message box

    &I #$ MsgTitle, InputTitle, InputMsg } @REQ>

Commands

 String input dialog request

  &I Command, Title , Message , Default
   Title   : Dialog title
   Message : Text above edit box
   Default : Text inside edit box
 
 File open dialog request

  &O Command, Title , Default , Pattern
   Title    : Dialog title
   Default  : Directory[filename.ext]
   Pattern  : Name|*.ext[;*.ext ...][|Name 2|*.ext ...]

 File save dialog request

  &S Command, Title , Default , Pattern
   Title    : Dialog title
   Default  : Directory[filename.ext]
   Pattern  : Name|*.ext[;*.ext ...][|Name 2|*.ext ...]

 Directory dialog request

  &D Command, Title , Directory
   Title     : Dialog title
   Directory : Starting directory path.

 Color dialog request

 &C Command, Red , Green , Blue
  Red      : Amount of red in default color
  Green    : Amount of green in default color
  Blue     : Amount of blue in default color

 Message box question request

 &Q Command, Title , Message , [Switch]
  Title    : Box title
  Message  : Box text
  Switch   : Number that alters question handling:
   0       : Perform command if 'No' selected
   1       : Perform command if 'Yes' selected (def)
   2       : Perform command regardless of 'Yes' or 'No'

 Ini read

 &R Command, File , [Group] , Key
  File     : Path to the ini file
  Group    : Optional ini section, reads root key otherwise.
  Key      : The key name you wish to read.

 String Replace

 &X Command, Search , Replace , String
  Search     : String to replace
  Replace    : Replacement string content
  String     : Target string