接口文件的通用部分
接口文件
当有相应脚本接口的事件发生时，就会生成一个接口文件。该文件作为初始化资源，为脚本应用程序提供有关组件、组件状态和触发事件用户的详细信息。接口文件遵循 INI 格式，并以 UTF-16 编码。
接口文件的结构
接口文件由多个节和键组成，其中一些节和键在所有事件中通用，而其他节和键则针对个别事件。
下面提供了通用节和键的完整列表，您可以在各自的描述中找到事件的具体细节。
[Common]
| 键 | I/O | 描述 |
|---|---|---|
| RootDirAdmin | I | 包含 versiondog 管理文件的目录的完整路径。 BeforeUpload 和 AfterUpload 事件未指定此键。 |
| DirPrjData | I | 包含项目文件的目录的完整路径。 BeforeUpload 和 AfterUpload 事件未指定此键。 |
| Language | I | 在 versiondog 中设置的语言 ID（例如：en，或更准确地说是 en-gb、en-us、de-de、fr-fr 等） |
| ComputerName | I | 执行脚本应用程序的计算机名称 格式：[Domain].ComputerName 对于客户端事件，指定客户端名称；对于服务器端事件，指定服务器名称。 |
| DirTemp | I | 脚本应用程序存储临时数据的目录完整路径。 每个脚本应用程序必须独立删除其临时数据。所有脚本应用程序共享一个临时数据目录。因此，必须清晰地分配子目录和文件，以确保每个脚本程序只删除自己的临时数据。 |
| PathLog | I | 存储记录信息的目录的完整路径。 某些脚本应用程序会向整个系统提供这些信息。每个脚本应用程序都必须独立删除这些数据。 |
| TimeOutInMin | I | 超时时间（分钟）。 警告：如果超过此处设置的时间值，脚本程序将立即关闭，且不会发出通知。 |
| Licence | I | 许可证中包含的功能信息 |
| PathExeVdog | I | 调用脚本应用程序的完整路径（例如，C:\Program Files\vdog\VDogClient.exe 或服务器应用程序的路径） |
| SilentMode | I | 表示脚本程序是否可以请求用户输入信息（例如通过消息）。 Y：不允许请求输入。 N：可以请求输入。 这并不意味着脚本应用程序实际上会请求输入。服务器端的默认值是 Y，客户端脚本应用的默认值是 N。 |
[Component]
某些脚本应用程序不支持此节。
| 键 | I/O | 描述 |
|---|---|---|
| Dir | I | 组件目录的相对路径。路径以反斜线开头。路径末尾没有反斜线。 |
| ID | I | 组件 ID |
| ComponentTypeId | I | 组件类型 ID |
| MasterData1 | I | 第一个主数据字段的内容 |
| MasterData2 | I | 第二个主数据字段的内容 |
| MasterData3 | I | 第三个主数据字段的内容 |
| MasterData4 | I | 第四个主数据字段的内容 |
| MasterData5 | I | 第五个主数据字段的内容 |
| MasterData6 | I | 第六个主数据字段的内容 |
| MasterData7 | I | 第七个主数据字段的内容 |
| MasterData8 | I | 第八个主数据字段的内容 |
| MasterData9 | I | 第九个主数据字段的内容 |
| MasterData10 | I | 第十个主数据字段的内容 |
[User]
某些脚本应用程序不支持此节。
| 键 | I/O | 描述 | 值 |
|---|---|---|---|
| ID | I | 用户名 | 32 个字符的字符串 |
| 名称 | I | 用户名 | |
| FullName | I | 用户全名。只有在 用户管理 模块中定义了用户名时，才会指定键值。 | |
| 域 | I | 用户登录的域。 | |
| EmailAddress | I | 存储在用户信息中的电子邮件地址（如果未设置电子邮件地址，则为空）。 | |
| LocalLogon | I | 显示用户是在本地登录还是在服务器上登录。 | Y： 用户已在本地登录。 N： 用户在服务器上登录。 |
| Admin | I | 显示用户是否属于管理员组。 | Y： 用户属于管理员组。 N： 该用户不属于管理员组。 |
| Groups | I | 用户所属的组的 ID。 | 32 个字符的字符串，用逗号分隔 |
[Version]
某些脚本应用程序不支持此节。在某些脚本应用程序中，该节的名称有所不同。
Info
只有在可以识别用户并成功检索到其信息的情况下，本节才会包含与用户相关的详细信息。如果无法做到这一点，以下键值将保持为空：
- UserName
- UserFullName
- UserDomainName
- UserEmailAddress
| 键 | I/O | 描述 |
|---|---|---|
| Hversion | I | 版本号 |
| HversionUserDefined | I | 用户定义的版本号 |
| TimeStampUtc | I | 以UTC-时间格式表示的版本控制时间（YYYYMMDDHHHMMSS） |
| TimeStampLocal | I | 以本地时间格式表示的版本控制时间（YYYYMMDDHHHMMSS） |
| 评论 | I | 对该版本的评论 换行符（LF、CR、CRLF）将被转换为 <br>。 |
| ChangeReason | I | 此版本更改的原因 换行符（LF、CR、CRLF）将被转换为 <br> 。 |
| UserId | I | 创建版本的用户 ID，由 32 个字符组成的字符串。 |
| UserName | I | 创建版本的用户名。 |
| UserFullName | I | 创建版本的用户全名。 只有在 用户管理 模块中设置了名称时，才会指定键值。 |
| UserDomainName | I | 用户登录的域。 |
| UserEmailAddress | I | 存储在用户信息中的电子邮件地址（如果未设置电子邮件地址，则为空）。 |
| ComputerName | I | 创建该版本的计算机的名称。 |
| DnameStorage | I | 存储版本存档的子目录名称，格式为 YYYYMMDD.{NNN} |
| State | I | 版本/存档的锁定状态 |
[QuickSave]
只有在还原组件的快速存档后，本节才可用。
| 键 | I/O | 描述 | 值 |
|---|---|---|---|
| Enabled | I | 表示该组件是否启用快速存档。 | Y：已启用快速存档。 N： 禁用快速存档。 如果未指定此键的值，系统将假定 N 为值。 |
| Dir | I | 组件目录的相对路径，以反斜线开头。路径末尾没有反斜杠。 只有当启用的键值为 Y 时，才会指定该键。 | |
| ID | I | 组件 ID 仅当 Enabled 键的值为 Y 时，才会指定此键。 |
[ExclusiveUse]
| 键 | I/O | 描述 |
|---|---|---|
| UserID | I | 为其他用户锁定组件的用户的 ID（32 个字符的字符串）。 如果没有指定值或指定的值为零，则不锁定组件。 |
| UserName | I | 为其他用户锁定组件的用户名。 |
| UserFullName | I | 为其他用户锁定组件的用户全名。 只有在 用户管理 模块中定义了该名称时，才会指定键值。 |
| DomainName | I | 用户登录的域。 |
| EmailAddress | I | 存储在用户信息中的电子邮件地址（如果未设置电子邮件地址，则为空）。 |
| ComputerName | I | 为其他用户锁定组件的计算机名称 |
| TimeStampUtc | I | 组件设置为该状态的时间，按 UTC 时间格式（YYYYMMDDHHMMSS） |
| TimeStampLocal | I | 组件设置为该状态的时间，按本地时间格式（YYYYMMDDHHMMSS） |
[UnderDevelopment]
| 键 | I/O | 描述 |
|---|---|---|
| UserId | I | 将组件标记为 开发中 的用户ID，使用32个字符的字符串表示。 如果未输入值或输入的值为零，则组件不会被标记为 开发中。 |
| UserName | I | 将组件标记为 开发中 的用户的名称 |
| UserFullName | I | 将组件标记为 开发中 的用户的全名。 只有在 用户管理 模块中定义了该名称时，才会指定该键。 |
| DomainName | I | 用户登录的域。 |
| EmailAddress | I | 存储在用户信息中的电子邮件地址（如果未设置电子邮件地址，则为空）。 |
| ComputerName | I | 将组件被标记为 开发中 的计算机的名称 |
| TimeStampUtc | I | 组件设置为该状态的时间，按 UTC 时间格式（YYYYMMDDHHMMSS） |
| TimeStampLocal | I | 组件设置为该状态的时间，按本地时间格式（YYYYMMDDHHMMSS） |
[ClientInformation]
| 键 | I/O | 描述 |
|---|---|---|
| ComputerName | I | 计算机名称，以及（如适用）签出或签入操作所使用计算机的相关域。 |
| IpAddress | I | 签出或签入操作所使用计算机的 IP 地址。 |
[Result]
| 键 | I/O | 描述 |
|---|---|---|
| ErrorText | O | 表示脚本应用程序是否因错误而终止，并发出错误消息。 消息会阻塞程序，直到被确认。因此，不应在服务器端脚本应用程序中使用此类消息。如果指定值为 <na>，则不会写入任何错误消息。 |
| Warnings | O | 显示脚本应用程序是否伴随着警告终止。 |