far.MacroAdd

far.MacroAdd

Id = far.MacroAdd (Area, Flags, AKey, SequenceText, Description, Callback, Priority)

Parameters:
  Area:         flags (defaults to MACROAREA_COMMON)
  Flags:        flags (defaults to 0)
  AKey:         table tInputRecord, or string (e.g. "CtrlShiftF12")
  SequenceText: string
  Description:  string (defaults to "")
  Callback:     function, or nil
  Priority:     integer (defaults to 50)

Returns:
  Id:           userdata (success), or nil (failure)
                  used in Callback and far.MacroDelete

Far API used:
  MacroControl(MCTL_ADDMACRO)

Example:
  local F = far.Flags

  local function Callback (Id, Flags)
    return some_condition and another_condition
  end

  local Id = far.MacroAdd(
    F.MACROAREA_SHELL,
    0,
    "CtrlShiftF12",
    'msgbox("test","test")',
    "cool macro",
    Callback)