首页 > 代码库 > 安装包制作工具 SetupFactory API清单

安装包制作工具 SetupFactory API清单

  2014-11-19

  SetupFactory中可以通过其API控制很复杂的业务需求。

  下图中展示了其内置的API种类与具体分类函数。

     

   

 

序号API名称API说明
1Application.Exit退出安装程序,并返回一个可选的返回代码
2Application.GetInstallLanguage返回一个包含当前安装语言的表格
3Application.GetLastError返回最后的错误代码
 Application.SetLastError更改最后的错误代码
4Application.GetWndHandle为安装程序窗口返回数字窗口句柄
5Application.LoadActionPlugin加载一个操作插件文件 (.lmd)。
7Application.LoadValue加载保存 Application.SaveValue 操作的值
8Application.Minimize最小化安装程序窗口到任务栏
9Application.LoadValue加载保存 Application.SaveValue 操作的值
10Application.Restore恢复安装程序窗口。
11Application.RunScriptFile执行外部脚本文件 (.lua) 的内容。
12Application.SaveValue保存值到用户的系统,以便今后可用
13Application.SetInstallLanguage设置指定的语言为安装语言
14Application.Sleep让安装程序休眠一段时间
15Debug.Clear清除调试窗口的内容
16Debug.GetEventContext

返回描述当前事件上下文的字符串,如:"欢迎 > 继续时"

17Debug.GetTraceMode返回当前调试跟踪模式
18Debug.Print追加文本到调试窗口的底部
19Debug.SetTraceMode

打开或关闭调试跟踪模式

20Debug.ShowWindow显示或隐藏调试窗口
21Dialog.FileBrowse显示一个文件浏览对话框,以便用户选择一个或多个文件的路径
22Dialog.FolderBrowse

显示文件夹浏览对话框,以便用户选择文件夹的路径

23Dialog.Input显示输入对话框,以便获取用户信息
24Dialog.MaskedInput

显示输入对话框,以便按指定格式获取用户信息

25Dialog.Message显示带有消息信息的对话框
26Dialog.PasswordInput显示“隐藏输入”对话框,以便获取用户输入的密码
27Dialog.TimedMessage显示带有消息信息的定时对话框
28Dialog.SplashImage

显示包含图像的闪屏对话框

29DlgButton.GetProperties获取当前屏幕上按钮控件的属性
30DlgButton.SetProperties设置当前屏幕上按钮控件的属性
31DlgCheckBox.GetProperties获取当前屏幕上检查框的属性
32DlgCheckBox.SetProperties设置当前屏幕上检查框控件的属性
33DlgComboBox.AddItem将项目添加到已排序的组合框控件。如果控件未排序,项目将被添加到末尾
34DlgComboBox.GetItemData获取当前屏幕上组合框控件中项目的关联数据字符串
35DlgComboBox.GetItemText返回当前屏幕上组合框控件中项目的文本
36DlgComboBox.GetProperties获取当前屏幕上组合框控件的属性
37DlgComboBox.InsertItem插入项目到组合框控件
38DlgComboBox.RemoveItem从组合框控件中移除项目
39DlgComboBox.SetItemData将组合框控件的项目设置为字符串,以便今后能被检索
40DlgComboBox.SetProperties设置当前屏幕上组合框控件的属性
41DlgEditField.GetProperties获取当前屏幕上编辑栏控件的属性
42DlgEditField.SetProperties设置当前屏幕上编辑栏控件的属性
43DlgListBox.AddItem

添加项目到列表框控件。如果列表框已排序,项目被添加到已排序的位置,否则被添加到末尾。

注意:此操作仅在从屏幕事件调用和指定的控件在当前屏幕上的时候工作。

44DlgListBox.DeleteItem从列表框控件中删除项目
45DlgListBox.FindItem基于搜索字符串在列表框中查找项目,并返回其索引
46DlgListBox.GetCount返回列表框控件中的项目数量
47DlgListBox.GetItemProperties获取已给出其索引的列表框控件中项目的属性
48DlgListBox.GetProperties获取当前屏幕上列表框控件的属性
49DlgListBox.GetSelected返回指定列表框控件中所有已选项的索引 (行号) 的数字索引表
50DlgListBox.GetSelectedCount返回列表框控件中已选项的数量
51DlgListBox.InsertItem将项目插入到列表框控件中的指定位置
52DlgListBox.SetItemProperties设置已给出其索引的列表框控件中项目的属性
53DlgListBox.SetProperties设置当前屏幕上列表框控件的属性
54DlgListBox.SetUpdate设置列表框控件的更新状态
55DlgProgressBar.GetPos返回进度条控件中进度表的当前位置
56DlgProgressBar.GetProperties返回包含当前屏幕上进度条控件属性的表格
57DlgProgressBar.GetRange返回包含当前屏幕上进度条控件范围的表格
58DlgProgressBar.SetPos设置当前屏幕上进度条控件中进度表的位置
59DlgProgressBar.SetProperties设置当前屏幕上进度条控件的属性
60DlgProgressBar.SetRange设置当前屏幕上进度条控件的范围
61DlgProgressBar.SetStep设置进度条控件的步长值,它将在 DlgProgressBar.Step 被调用时使用
62DlgProgressBar.Step通过在 DlgProgressBar.SetStep 操作中指定的步长数量来增加当前进度
63DlgRadioButton.GetProperties获取当前屏幕上单选按钮控件的属性
64DlgRadioButton.SetProperties设置当前屏幕上单选按钮控件的属性
65DlgScrollingText.AppendLine追加新行到滚动文本控件中的当前文本
66DlgScrollingText.SetProperties设置当前屏幕上滚动文本控件的属性
67DlgSelectPackages.GetCategoryProperties获取当前屏幕上选择程序包控件中程序包类别的属性
68DlgSelectPackages.SetCategoryProperties设置当前屏幕上选择程序包控件中程序包类别的属性
69DlgSelectPackages.UpdateDisplay基于当前内部数据来更新当前显示的程序包列表
70DlgStaticText.GetProperties获取当前屏幕上静态文本控件的属性
71DlgStaticText.SetProperties设置当前屏幕上静态文本控件的属性
72DLL.CallFunction调用动态链接库 (DLL) 中的函数。它可用于以你自己的函数来扩充 Setup Factory 的功能
73Drive.Eject当给出了有效的盘符时弹出 CD 或 DVD-ROM
74Drive.Enumerate返回包含用户系统上所有驱动器的数字索引表
75Drive.GetFreeSpace获取指定驱动器的剩余磁盘空间,并返回其大小 (MB)
76Drive.GetInformation返回有关指定驱动器的信息表
77Drive.GetSize获取指定硬盘的磁盘空间,并返回其大小 (MB)
78Drive.GetType获取指定驱动器的类型
79Drive.GetUsedSpace获取指定驱动器的已用磁盘空间,并返回其大小 (MB)
80File.Copy复制文件到其他位置
81File.Delete删除文件
82File.DeleteOnReboot下次系统重启时删除文件
83File.DoesExist如果文件存在于指定位置就返回 true,否则返回 false
84File.ExploreFolder浏览用户系统上的文件夹
85File.Find在本地系统上搜索文件
86File.GetAttributes给指定文件返回包含所有属性的表格
87File.GetCRC给指定文件返回 CRC 值
88File.GetDefaultViewer返回路径到与指定文件扩展名关联的默认阅读程序
89File.GetShortName获取文件的完整路径和文件名的“8.3”样式
90File.GetSize返回文件的大小 (字节)
91File.GetVersionInfo给指定文件返回包含所有版本信息的表格
92File.Install将文件安装到用户系统
93File.IsInUse确定指定文件是否正在使用。如果文件正在使用,就不能复制或删除
94File.Move移动文件到其他位置
95File.MoveOnReboot下次系统重启时将文件从一个位置移动到另一个位置
96File.Open用默认的阅读程序打开文档文件
97File.OpenEmail用目标栏中的 Email 地址打开用户的默认 Email 客户端
98File.OpenURL在用户的默认网络浏览器中打开本地文件或网络地址
99File.Print在用户的默认打印机上打印文档
100File.Rename重命名文件
101File.Run运行可执行文件
102File.RunOnReboot下次系统重启时运行执行程序
103File.SetAttributes设置文件的属性
104Folder.Create创建新文件夹
105Folder.Delete删除文件夹
106Folder.DeleteTree删除指定的文件夹及其子文件夹中的所有文件
107Folder.DoesExist如果指定文件夹存在就返回 true,否则返回 false
108Folder.Find搜索文件夹
109Folder.GetCurrent返回“当前文件夹”(工作目录)
110Folder.Rename重命名文件夹
111Folder.SetCurrent设置应用程序的“当前文件夹”(工作目录)
112HTTP.Download从网站上下载文件 
113HTTP.DownloadSecure使用 HTTPS (安全超文本传输协议) 从网站下载文件
114HTTP.GetConnectionState检索用户的 Internet 连接状态
115HTTP.GetHTTPErrorInfo

检索有关最后发生错误的 HTTP 指定信息

116HTTP.Submit提交数据到网站,并从服务器返回响应
117HTTP.SubmitSecure使用 HTTPS (安全超文本传输协议) 提交数据到网站,并从服务器返回响应
118HTTP.TestConnection检查用户的 Internet 连接
119INIFile.DeleteSection删除指定 INI 文件中的“区段”
120INIFile.DeleteValue删除指定 INI 文件中的“值”
121INIFile.GetSectionNames返回 INI 文件中的所有“区段”名称
122INIFile.GetValue返回指定 INI 文件中与“值”关联的数据
123INIFile.GetValueNames返回 INI 文件的区段中的所有“值”名称
124INIFile.SetValue设置值的数据
125Math.Abs返回数字的绝对值
126Math.Acos返回数字的反余弦 (弧度)
127Math.Asin返回数字的反正弦 (弧度)
128Math.Atan返回数字的反正切 (弧度)
129Math.Atan2返回 Num1/Num2 的反正切 (弧度)
130Math.Ceil返回数字的上限
131Math.Cos返回数字的余弦
132Math.Deg将数字从弧度转换为度数
133Math.Exp返回数字的指数值
134Math.Floor返回数字的下限
135Math.Frexp返回数字(x) 的尾数(m) 和指数(n) (方程式:x = m * 2^n) 的表格
136Math.Ldexp已知尾数(m) 和指数(n) (方程式:x = m * 2^n),返回数字(x)
137Math.Log返回数字的对数
138Math.Log10返回数字的基数为 10 的对数
139Math.Max比较两个数字,并返回最大数
140Math.Min比较两个数字,并返回最小数
141Math.Mod返回 Num1/Num2 的系数
142Math.Pow返回基数乘至指数幂的计算
143Math.Rad将数字从度数转换为弧度
144Math.Random生成随机数
145Math.RandomSeedMath.Random 的随机数
146Math.Round按指定的小数位数返回“四舍五入”后的数字
147Math.Sin返回弧度值的正弦
148Math.Sqrt返回数字的平方根
149Math.Tan返回弧度值的正切
150 ODBC.ConfigDataSource 配置 ODBC 数据源
151  ODBC.InstallDriver 安装 ODBC 驱动程序
152  ODBC.InstallManager 安装驱动程序管理器
153  ODBC.UninstallDriver 移除 ODBC 驱动程序,并返回该操作之后驱动程序的使用统计
154  ODBC.UninstallManager 卸载驱动程序管理器,并返回该操作之后的使用统计
155  Registry.CreateKey 在用户的注册表中创建“键”
156  Registry.DeleteKey 从用户的注册表中删除“键”
157  Registry.DeleteValue 从用户的注册表中删除“值”
158  Registry.DoesKeyExist 确定是否存在指定的注册表键,并返回 true 或 false
159  Registry.GetAccess 检查注册表键是否有指定的访问权限,并返回 true 或 false
160Registry.GetKeyNames 给指定的键返回包含所有子键名称的表格
161Registry.GetValue 返回指定注册表值的数据
162Registry.GetValueNames 返回指定子键中所有的值名称
163Registry.GetValueType 返回注册表值的类型
164Registry.SetValue设置指定注册表值的数据
165Screen.Back返回到一个已查看过的屏幕。此操作类似网络浏览器上的返回按钮
166Screen.End跳转到当前屏幕列表的末尾,并开始安装中的下一个阶段
167Screen.GetFocus获取当前控件的 ID
168Screen.GetLocalizedString获取当前语言中字符串 ID 的文本
169Screen.GetProperties获取当前屏幕的属性
170Screen.Jump跳转到指定屏幕
171Screen.Next依照屏幕管理器中的顺序进入屏幕列表中的下一个屏幕
172Screen.Previous依照屏幕管理器中的顺序进入屏幕列表中的上一个屏幕
173 Screen.SetFocus 给控件设置焦点
174 Screen.SetLocalizedString 设置当前语言中字符串 ID 的文本
175 Screen.StartTimer 启动计时器
176 Screen.StopTimer 停止计时器
177 Service.Continue 继续指定的服务
178 Service.Create 在本地系统中创建服务
 179  Service.Delete 从服务数据库中删除指定的服务
180 Service.Pause 暂停指定的服务
181 Service.Query 查询指定服务的状态
182  Service.Start 启动服务
183 Service.Stop 停止服务
184 SessionVar.Expand 返回包含给定的会话变量的内容的字符串
185 SessionVar.Get 返回未展开的会话变量的内容
186 SessionVar.Remove 在运行时从会话变量管理器中移除给定的会话变量
187 SessionVar.Set 将给定的会话变量设置为指定的值
188  SetupData.CalculateRequiredSpace 计算安装所需的磁盘空间
189  SetupData.GetAppShortcutFolderPath 获取存放应用程序快捷方式的文件夹
190  SetupData.GetFileListSetupData.GetLocalizedString 获取全局字符串的定位文本 (基于当前安装语言)
191  SetupData.GetPackageList 返回包含在当前安装程序中的程序包 ID 的数字索引表
192 SetupData.GetPackageProperties 返回包含给定的程序包属性的表
193 SetupData.GetSerialListNames 返回包含所有序列号列表名称的数字索引表
194 SetupData.IsValidSerialNumber 检查给定的序列号在指定的序列号列表中是否有效
195 SetupData.SetLocalizedString 设置当前语言中字符串 ID 的文本
196 SetupData.SetPackageProperties 设置给定的程序包的属性
197 SetupData.WriteToLogFile 将文本的字符串写入安装或卸载日志文件
198 Shell.CreateShortcut 创建快捷方式
199 Shell.DeleteShortcut 移除快捷方式
200 Shell.GetFolder 返回公共文件夹的路径,如:"My Documents" 或用户的启动文件夹
201 StatusDlg.GetMeterPos 返回状态对话框的当前状态表位置
202 StatusDlg.Hide 隐藏内建的状态对话框
203 StatusDlg.IsCancelled 如果点击了内建状态对话框上的取消按钮就返回 true,否则返回 false
204 StatusDlg.SetMessage 设置内建状态对话框上的主要描述信息
205 StatusDlg.SetMeterPos

 设置内建状态对话框上的状态表位置
206 StatusDlg.SetMeterRange  设置内建状态对话框的状态表的范围
207 StatusDlg.SetStatusText 设置内建状态对话框上的状态文本。这是显示在状态表上的文本
208 StatusDlg.SetTitle 设置内建状态对话框上的标题栏
209 StatusDlg.SetCancelled 设置内建状态对话框上取消按钮的已点击/未点击状态
210 StatusDlg.Show 显示内建状态对话框
211 StatusDlg.ShowCancelButton 显示或隐藏内建状态对话框上的取消按钮
212  StatusDlg.ShowProgressMeter 显示或隐藏内建状态对话框上的进度表
213  String.AbbreviateFilePath 返回简短的文件路径
214 String.Asc 返回字符的 ASCII 代码 (十进制)
215 String.Char 返回指定 ASCII 代码的字符值 (十进制)
216 String.Compare 比较两个字符串 (区分大小写)
217 String.CompareFileVersions 比较两个文件的版本
218 String.CompareNoCase
 
 比较两个字符串 (区分大小写)
219  String.Concat 添加 (或连接) 两个字符串,并返回结果为一个新字符串
220  String.Find 查找子字串第一次出现的位置
221  String.GetFormattedSize 给定字节数,返回格式化字符串,转换为 字节、KB、MB 或 GB,并可插入逗号
222  String.Left 从现有字符串的最左边的 x 个字符创建一个新字符串
223  String.Length 返回字符串中的字符数量
224  String.Lower 返回字符串的全小写样式
225  String.MakePath 返回基于指定表中元素的路径
226  String.Mid 从字符串返回指定的字符范围
227  String.Repeat 按给定的次数重复字符串
228  String.Replace 在字符串中搜索子字串,并将其替换为新的子字串
229 String.ReverseFind 从右到左搜索子字串在字符串中第一次出现的位置
230  String.Right 从现有字符串的最右边 x 个字串创建新的字符串
231 String.ToNumber 将数字字符串转换为数字值
232 String.SplitPath 将指定的路径分割为驱动器、文件夹、文件名和扩展名
234 String.TrimLeft 从源字符串的左边清除指定的字符
235 String.TrimRight 从源字符串的右边清除指定的字符
236 String.Upper 返回字符串的全大写样式
237 System.GetDate 按各种格式返回当前日期
238 System.GetDefaultLangID 返回包含主、次语言 ID 的表
239 System.GetDisplayInfo 返回包含用户系统的显示信息的表
240 System.GetLANInfo 返回包含用户局域网信息的表
241 System.GetOSName 返回操作系统的名称,如:"Windows 2000"
242 System.GetOSVersionInfo 返回包含操作系统版本信息的表
243 System.GetTime 按各种格式返回当前时间
244 System.GetUserInfo 返回包含用户信息的表
245 System.Reboot 重启用户系统
246 System.RegisterActiveX 注册 ActiveX 控件
247 System.RegisterFont 注册 TrueType 字体 (.ttf 文件)
248 System.RegisterTypeLib 注册类型库文件 (.tlb)
249 System.UnregisterActiveX 卸载注册 ActiveX 控件
250 System.UnregisterFont 卸载注册 TrueType 字体 (.ttf 文件)
251 Table.Concat 返回包含表中某些或全部值的字符串。这些值必须由定界符分隔
252 Table.Count 返回表中的项目总数
253 Table.Sort 排序数字索引表的项目
254 Table.Insert 将项目插入到数字索引表的指定位置
255 Table.Remove 从数字索引表中移除指定项目,并返回其值
256 TextFile.ReadToString 读取文本文件的内容,并将其返回为字符串
257 TextFile.ReadToTable 将文本文件的内容读取到表中
258 TextFile.WriteFromString 将文本的字符串写入到文本文件
259 TextFile.WriteFromTable 将表的内容写入到文本文件。表中每项一行
260 UninstallData.AddItem 将项目添加到卸载配置文件。如果项目已存在,现有项目将被新数据覆盖
261 UninstallData.GetConfigurationFile 获取卸载配置文件 (xml) 的完整路径和文件名
262 UninstallData.GetItem 从卸载配置文件中获取项目的详情
263  UninstallData.GetItemList 按给定的卸载数据类型返回标识符的数字索引表
264 UninstallData.RemoveItem 从卸载配置文件中移除项目
265 UninstallData.SetConfigurationFile 设置卸载配置文件 (xml) 的名称
266 Window.Close 关闭用户桌面上的指定窗口
267 Window.EnumerateProcesses 返回包含所有当前运行进程的列表及其关联窗口句柄的表
268 Window.EnumerateTitles 返回包含所有打开窗口的窗口标题和窗口句柄的表
269 Window.GetPos 返回窗口的 X 和 Y 屏幕坐标 (像素)
270 Window.GetSize 返回窗口的像素尺寸
271 Window.Hide 隐藏指定窗口
272 Window.Maximize 最大化指定窗口
273 Window.Minimize 最小化指定窗口
274 Window.Restore 恢复指定窗口
275 Window.SetOrder 设置相对于其他可见窗口的窗口 Z 顺序
276 Window.SetPos 设置指定窗口相对于屏幕的 X 和 Y 像素坐标
277 Window.SetSize 设置指定窗口的大小
278 Window.SetText 设置指定窗口的标题文本。此文本将显示在窗口的标题栏和任务栏
279 Window.Show 显示指定窗口

 

上一篇》安装包制作工具 SetupFactory 详解

 

 

 

 

   如果文章对您有帮助,请帮忙推荐,谢谢!

   欢迎转载,请注明文章出处与链接信息!

安装包制作工具 SetupFactory API清单