Class Class_App

App 类

Lua 对象

this.Lua

Lua - 属性

Lua.Version Lua模块版本信息

Script 对象

this.Script

Script - 属性

Script.Name 脚本文件名
Script.Path 脚本所在目录
Script.File 脚本文件的完整路径
Script:Require (dir1[, dir2[, dir3]]) 依赖引用(脚本所在目录的其他Lua库)
Script:ChDirHere () 切换工作目录到脚本所在目录

App 对象

this.App

App - 属性

App.Version 程序版本信息
App.Name 程序文件名
App.Path 程序所在目录
App.FullPath 程序的全路径名
App.CmdLine 程序的命令行参数
App.PID 程序的进程ID

App - 方法

App:HasOption (opt) 判断程序参数
App:GetOption (opt) 获取程序指定参数
App:UseLuaDll () 将<程序所在目录>\Libs\(x86|x64)目录加入到PATH环境变量中,
便于使用第三方Lua库或外部命令
App:Require (dir1[, dir2[, dir3]]) 依赖引用(<程序所在目录>\Libs下的其他Lua库)
App:Alert (data1[, data2[, ...]]) 使用对话框显示数据内容(调试时使用)
App:Info (key) 获取 信息
App:CreateGUID () 生成 一个GUID序列字符串
App:Exec () 调用 子程序 (等待程序结束)
App:Run () 启动 程序 (不等待)
App:Sleep (ms) 暂停 当前进程(线程)执行, 用于等待或者延时处理
App:Pause () 暂停 作为启动管理器时，可用此命令维持启动进程
App:SetTimer (id, interval) 注册 计时器
App:KillTimer (id) 结束 计时器
App:Print (...) 输出 信息
App:JCfg (section, key1[, key2[, ...]]) 获取 WinXShell.jcfg中的配置参数
App:ExitCode (code) 设置脚本执行的退出码
App:Exit (code) 指定程序退出码并终止程序

App - 事件函数

App:OnLoad () 程序启动事件
App:OnDaemon () 作为常驻进程时，启动事件
App:OnTimer () 计时器事件


Lua 对象

this.Lua

Lua - 属性

Lua.Version
Lua模块版本信息

Script 对象

this.Script

Script - 属性

Script.Name
脚本文件名
Script.Path
脚本所在目录
Script.File
脚本文件的完整路径
Script:Require (dir1[, dir2[, dir3]])
依赖引用(脚本所在目录的其他Lua库)

Parameters:

Usage:

    Script:Require('socket', 'mime')
Script:ChDirHere ()
切换工作目录到脚本所在目录

App 对象

this.App

App - 属性

App.Version
程序版本信息
App.Name
程序文件名
App.Path
程序所在目录
App.FullPath
程序的全路径名
App.CmdLine
程序的命令行参数
App.PID
程序的进程ID

App - 方法

App:HasOption (opt)
判断程序参数

Parameters:

Usage:

    App:HasOption('-console')
App:GetOption (opt)
获取程序指定参数

Parameters:

Usage:

    -- WinXShell.exe -script path\to\file.lua
App:GetOption('-script') -- => path\to\file.lua
App:UseLuaDll ()
将<程序所在目录>\Libs\(x86|x64)目录加入到PATH环境变量中,
便于使用第三方Lua库或外部命令
App:Require (dir1[, dir2[, dir3]])
依赖引用(<程序所在目录>\Libs下的其他Lua库)

Parameters:

Usage:

    App:Require('socket', 'mime')
App:Alert (data1[, data2[, ...]])
使用对话框显示数据内容(调试时使用)

Parameters:

  • data1 数据1
  • data2 数据2 (optional)
  • ... (optional)

See also:

Usage:

    App:Alert(App.Path)
App:Alert('abc', 123)
App:Info (key)
获取 信息

Parameters:

  • key string

    信息名

    • CmdLine - 命令行
    • Path - 程序所在目录
    • Name - 程序文件名
    • FullName - 程序完整路径名
    • IsShell - 是否WinXShell作为系统外壳程序

Returns:

    请查看实例代码

Usage:

    -- WinXShell.exe -script info.lua
-- info.lua
 App:Info('CmdLine')
 ---> '-script info.lua'

App:Info('Path')
 ---> C:\Program Files\WinXShell

App:Info('Name')
 ---> WinXShell.exe

App:Info('FullName')
 ---> C:\Program Files\WinXShell\WinXShell.exe

App:Info('IsShell')
 ---> 0
App:CreateGUID ()
生成 一个GUID序列字符串
App:Exec ()
调用 子程序 (等待程序结束)
App:Run ()
启动 程序 (不等待)
App:Sleep (ms)
暂停 当前进程(线程)执行, 用于等待或者延时处理

Parameters:

  • ms integer 暂停时间 (毫秒)

See also:

Usage:

    WinXShell.exe -console -code App:Sleep(5000)
App:Pause ()
暂停 作为启动管理器时，可用此命令维持启动进程

Usage:

    App:Pause()
App:SetTimer (id, interval)
注册 计时器

Parameters:

  • id integer 计时器标识号 (请使用 TID_USER + 数字形式 设置，
    小于 TID_USER (20000) 以下的标识号作为程序内部计时器标识号)
  • interval integer 时间间隔 (毫秒)

Usage:

    local TID_REFRESH_APP = TID_USER + 1        -- TID_USER = 20000
App:SetTimer(TID_REFRESH_APP, 2000)
App:KillTimer (id)
结束 计时器

Parameters:

  • id integer 计时器标识号
App:Print (...)
输出 信息

Parameters:

  • ...
App:JCfg (section, key1[, key2[, ...]])
获取 WinXShell.jcfg中的配置参数

Parameters:

  • section string 段名
  • key1 string 项目名
  • key2 string 项目名 (optional)
  • ... (optional)
App:ExitCode (code)
设置脚本执行的退出码

Parameters:

  • code
App:Exit (code)
指定程序退出码并终止程序

Parameters:

  • code

App - 事件函数

App:OnLoad ()
程序启动事件
App:OnDaemon ()
作为常驻进程时，启动事件
App:OnTimer ()
计时器事件
generated by LDoc 1.5.0