包装类

别名

串

注意：只读

别名

批量加载

长

注意：读/写

指示从受控包批量导入过程中批量加载包的标志。

目前未使用。

批量保存

长

注意：读/写

布尔值，指示软件包是否包含在批处理XMI导出列表中。

代码路径

串

注意：读/写

找到相关源代码的路径。

目前未使用。

连接器

采集

注意：只读

连接器的集合。

已建立

日期

注意：读/写

包创建的日期。

图表

采集

注意：只读

此软件包中包含的图的集合。

元件

元件

注意：只读

关联的元素对象；用于获取/设置常见信息，例如刻板印象，复杂性，别名，作者，约束，标记值和方案。

元素

采集

注意：只读

属于此Package的元素的集合。

标志

串

注意：读/写

有关软件包的扩展信息。

被控制

布尔型

注意：读/写

指示包是否已标记为“受控”。

IsModel

布尔型

注意：只读

指示包是模型还是包。

IsNamespace

布尔型

注意：读/写

True表示“包是命名空间的根”。

使用0和1设置False和True。

受保护

布尔型

注意：读/写

指示包是否已标记为“受保护”。

IsVersionControlled

布尔型

注意：只读

指示此软件包是否受版本控制。

LastLoadDate

日期

注意：读/写

包的XML上次加载日期。

LastSaveDate

日期

注意：读/写

XML的最后保存日期。

LogXML

布尔型

注意：读/写

指示是否要记录XMI导出信息。

改性

日期

注意：读/写

包的最后修改日期。

名称

串

注意：读/写

包的名称。

笔记

串

注意：读/写

有关此软件包的说明。

对象类型

对象类型

注意：只读

区分通过Dispatch接口引用的对象。

所有者

串

注意：读/写。

使用受控程序包时的程序包所有者。

包GUID

变体

注意：只读

全局Package ID；跨模型有效。

包裹ID

长

注意：只读

本地程序包ID号。

仅在此模型文件中有效。

配套

采集

注意：只读

可以遍历的包含的软件包的集合。

父母ID

长

注意：读/写

作为该父项的Package的ID。

0表示此Package是模型（也就是说，它没有父代）。

刻板印象

串

注意：读/写

逗号分隔列表中元素的所有已应用构造型。读取该值将仅提供构造型名称。分配值可以接受标准名称或简单名称。

设置此属性时，LastError（来自GetLastError方法）在发生错误时将为非空。

TreePos

长

注意：读/写

与其他Packages相比在树中的相对位置（用于对Packages进行排序）。

TypeInfoProperties

注意：只读

返回TypeInfoProperties的接口指针。

UML版本

串

注意：读/写

用于XMI导出的UML版本。

使用DTD

布尔型

注意：读/写

指示导出XMI时是否要使用DTD。

版

串

注意：读/写

软件包的版本。

XML路径

串

注意：读/写

使用受控程序包时XML保存到的路径。

ApplyGroupLock（字符串aGroupName）

布尔型

注意：代表当前用户，为指定的组对Package对象应用组锁定。用户安全适用于此功能的使用；如果用户没有权限对元素，图和包应用或释放锁，则该操作将失败。

如果操作成功，则返回True。如果操作失败，则返回False。使用GetLastError（）检索错误信息。

参数：

• aGroupName：字符串-要对其应用锁定的安全组的名称

ApplyGroupLockRecursive（字符串aGroupName，布尔IncludeElements，布尔IncludeDiagrams，布尔IncludeSubPackages）

布尔型

注意：代表当前用户，为指定的组对Package对象，对象以及该Package中包含的所有Package，图和元素应用组锁。用户安全适用于此功能的使用；如果用户没有权限对元素，图和包应用或释放锁，则该操作将失败。

如果操作成功，则返回True。如果操作失败，则返回False。使用“ GetLastError（）”来检索错误信息。

参量

• aGroupName：字符串-要对其应用锁定的安全组的名称

• IncludeElements：布尔值-将组锁递归应用于子元素

• IncludeDiagrams：布尔值-将组锁递归应用于子图

• IncludeSubPackages：布尔值-递归地将组锁应用于子包

ApplyUserLock（）

布尔型

注意：将用户锁应用于当前用户的Package对象。用户安全适用于此功能的使用；如果用户没有权限对元素，图和包应用或释放锁，则该操作将失败。

如果操作成功，则返回True。如果操作失败，则返回False。使用“ GetLastError（）”来检索错误信息。

ApplyUserLockRecursive（布尔IncludeElements，布尔IncludeDiagrams，布尔IncludeSubPackages）

布尔型

注意：将用户锁应用于Package对象以及该Package中包含的所有Package，图和元素。用户安全适用于此功能的使用；如果用户没有权限对元素，图和包应用或释放锁，则该操作将失败。

如果操作成功，则返回True。如果操作失败，则返回False。使用GetLastError（）检索错误信息。

参量

• IncludeElements：布尔值-递归将用户锁定应用于子元素
• IncludeDiagrams：布尔值-递归将用户锁定应用于子图
• IncludeSubPackages：布尔值-递归地将用户锁应用于子包

克隆

LDISPATCH

注意：将软件包的副本插入到与原始软件包相同的父文件夹中。

返回新创建的包。

FindObject（字符串DottedID）

LPDISPATCH

注意：返回与参数DottedID匹配的Package，元素，属性或操作。

如果未找到DottedID，则返回错误： 找不到匹配的对象。

参量

• DottedID：字符串-格式为'object.object.object'，其中object被Package，元素属性或操作的名称替换；示例包括MyNamespace.Class1，CStudent.m_Name，MathClass.DoubleIt（int）

GetLastError（）

串

注意：返回一个字符串值，该字符串值描述与该对象有关的最新错误。

GetTXAlias（字符串代码，长标志）

串

注意：返回给定语言的元素的别名。

参量

• 代码：字符串-两字母的语言代码（位于“管理项目选项”对话框的“翻译”页面上）
• 标记：长
  -0 =获取当前存储的翻译别名
  -1 =获取当前存储的翻译别名，如果原始别名已更改，则自动翻译
  -2 =始终从在线获取翻译的别名

GetTXNote（字符串代码，长标志）

串

返回给定语言的元素的注释。

参量

• 代码：字符串-两字母的语言代码（位于“管理项目选项”对话框的“翻译”页面上）

• 标记：长
  -0 =获取当前存储的翻译笔记
  -1 =获取当前存储的已翻译注释，如果原始注释已更改，则自动翻译
  -2 =始终从在线获取翻译的注释

SetTXAlias（字符串代码，字符串翻译）

串

注意-为给定语言设置元素的翻译别名。

• 代码：字符串-两字母的语言代码（位于“管理项目选项”对话框的“翻译”页面上）
• 翻译：字符串-翻译的别名

SetTXName（字符串代码，字符串转换）

串

注意-为给定语言设置元素的翻译名称。

• 代码：字符串-两字母的语言代码（位于“管理项目选项”对话框的“翻译”页面上）
• 翻译：字符串-转换后的名称

SetTXNote（字符串代码，字符串翻译）

串

注释-为给定语言设置元素的翻译注释。

• 代码：字符串-两字母的语言代码（位于“管理项目选项”对话框的“翻译”页面上）
• 翻译：字符串-翻译后的注释

GetTXName（字符串代码，长标志）

串

注意：返回给定语言的元素名称。

参量

• 代码：字符串-两字母的语言代码（位于“管理项目选项”对话框的“翻译”页面上）
• 标记：长
  -0 =获取当前存储的翻译名称
  -1 =获取当前存储的翻译名称，如果原始名称已更改，则自动翻译
  -2 =始终从在线获取翻译的名称

ReleaseUserLock（）

布尔型

注意：从Package对象以及该Package中包含的所有Package，图和元素中释放用户锁和组锁。用户安全适用于此功能的使用；如果用户没有权限对元素，图和包应用或释放锁，则该操作将失败。

如果操作成功，则返回True。如果操作失败，则返回False。使用GetLastError（）检索错误信息。

ReleaseUserLockRecursive（布尔IncludeElements，
布尔IncludeDiagrams，
布尔IncludeSubPackages）

布尔型

注意：从Package对象以及该Package中包含的所有Package，图和元素中释放用户锁。用户安全适用于此功能的使用；如果用户没有权限对元素，图和包应用或释放锁，则该操作将失败。

如果操作成功，则返回True。如果操作失败，则返回False。使用GetLastError（）检索错误信息。

参量

IncludeElements：布尔值-从子元素递归释放用户锁

IncludeDiagrams：布尔值-从子图中递归释放用户锁

IncludeSubPackages：布尔值-从子包中递归释放用户锁

SetReadOnly（布尔值ReadOnly，布尔值IncludeSubPkgs）

空洞

注意：设置程序包标志以将程序包标记为ReadOnly = 1。

如果启用了Project Security，则用户必须具有“配置包”权限才能使用此方法。

如果由于用户没有“配置软件包”权限而导致操作失败，则抛出异常；使用“ GetLastError（）”来检索错误信息。

参量

• ReadOnly：布尔值-设置或清除程序包上的“只读”标志；如果：

是的，将只读标志应用于包

• IncludeSubPkgs：布尔值-指示是仅在对象Package上还是在对象Package及其包含的所有嵌套子包上设置/重置只读标志。如果：

的确，为对象Package及其包含的所有嵌套子Package设置（或清除，根据ReadOnly参数）标志

使用版本控制的软件包时，无论已签入还是签出，均可将只读标志应用于这些软件包。

用户安全性适用于设置此标志-如果阻止您编辑程序包，则也将阻止设置该标志。

更新（）

布尔型

注意：修改或附加新项目后，更新当前Package对象。

如果返回False，请检查“ GetLastError（）”函数以获取更多信息。

请注意，Package对象还具有必须考虑的元素组件。 Package对象包含有关Package属性的信息，例如层次结构或内容。

element属性包含有关例如构造型，约束或文件的信息-典型元素的所有属性。

VersionControlAdd（字符串ConfigGuid，字符串XMLFile，字符串Comment，布尔值KeepCheckedOut）

空洞

注意：使用指定的版本控制配置和指定的XMI文件名将包置于版本控制下。

如果操作失败，则引发异常；使用GetLastError（）检索错误信息。

建议在调用VersionControlAdd（）之前使用Update（）保存该软件包，以免丢失所有未完成的更改。

参量

• ConfigGuid：字符串-对应于要使用的版本控制配置的唯一ID的名称
• XMLFile：字符串-用于此Package的XML文件的名称。该文件名相对于为Config指定的“工作副本”文件夹
• 注释：字符串-添加到版本控制文件的历史记录中的日志消息（如果适用）
• KeepCheckedOut：布尔值-指定True以添加到Version Control并保持Package处于检出状态

VersionControlCheckin（字符串注释）

空洞

注意：执行版本控制包的签入（另请参见VersionControlCheckinEx）。

如果操作失败，则引发异常；使用GetLastError（）检索错误信息。

参量

• 注释：字符串-添加到版本控制文件的历史记录中的日志消息（如果适用）

VersionControlCheckinEx（字符串注释，布尔PreserveCrossPkgRefs）

空洞

注意：执行版本控制包的签入。

如果操作失败，则引发异常；使用GetLastError（）检索错误信息。

参量

• 注释：字符串-添加到版本控制文件的历史记录中的日志消息（如果适用）
• PreserveCrossPkgRefs：布尔值-标记以指示在签入时是保留还是丢弃先前存在的交叉包引用；此参数将覆盖“首选项”对话框“ XML规范”页面中的设置
  不满意的跨包引用将根据此设置保留或丢弃，而不会提示用户。查看更多

VersionControlCheckout（字符串注释）

空洞

注意：执行版本控制包的检出。

如果操作失败，则引发异常；使用GetLastError（）检索错误信息。

参数：

• 注释：字符串-添加到版本控制文件的历史记录中的日志消息（如果适用）

VersionControlGetLatest（布尔ForceImport）

空洞

注意：在从Package文件重新导入Package数据之前，更新与对象Package关联的Package文件的本地工作副本。

参数：

• ForceImport：布尔值-如果发现模型中的Package数据相对于Version Controlled Package文件是最新的，则使用此方法；如果：
  -False，模型中存在的Package数据被认为是最新的，否
  试图从包文件中重新导入数据
  -是的，无论系统如何从Package文件重新导入Package

在使用私有模型部署的环境中工作并且您的模型包含大量交叉包引用时，建议您在重新导入以下文件后，不时调用“ Repository.ScanXMIAndReconcile（）”方法。受控程序包-例如，在使用'Package.VersionControlGetLatest（）'更新多个程序包之后，或在执行了许多程序包检出之后。

VersionControlGetStatus（）

长

注意：返回程序包的版本控制状态，记录在当前项目数据库中。

如果操作失败，则引发异常；使用GetLastError（）检索错误信息。

返回值映射到此枚举类型：

枚举EnumCheckOutStatus

{

csUncontrol = 0，

csCheckedIn，

csCheckedOutToThisUser，

csReadOnlyVersion，

csCheckedOutToAnotherUser，

csOfflineCheckedIn，

csCheckedOutOfflineByUser，

csCheckedOutOfflineByOther，

csDeleted，

};

• csUn受控-无法与与软件包相关联的版本控制提供程序进行通信，或者提供程序未知软件包文件
• csCheckedIn-程序包未检出给当前项目数据库中的任何人
• csCheckedOutToThisUser-程序包在当前项目数据库中标记为已签出给当前用户
• csReadOnlyVersion-程序包被标记为只读；已从版本控制中检索到该程序包的较早版本
• csCheckedOutToAnotherUser-该软件包在当前项目数据库中被当前用户以外的其他用户标记为已签出
• csOfflineCheckedIn-在当前项目数据库中，该包未检出给任何人；但是，与软件包关联的版本控制配置无法连接到VC服务器
• csCheckedOutOfflineByUser-在与版本控制断开连接的情况下，此用户已在该数据库中“检出”软件包
• csCheckedOutOfflineByOther-在与版本控制断开连接的情况下，另一个用户在此项目数据库中检出了包
• csDeleted-软件包文件已从版本控制中删除

VersionControlPutLatest（字符串CheckInComment）

空洞

注意：对版本控制的软件包执行签入，同时使软件包保持检出状态。

如果操作失败，则引发异常；使用GetLastError（）检索错误信息。

当以前标记为“已签出脱机”的软件包成功“放入”（签入）版本控制时，该软件包的标志将更新以清除“已签出脱机”指示器。

参数：

• 注释：字符串-日志消息已添加到版本控制文件的历史记录中（如果适用）

VersionControlRemove（）

空洞

注意：从软件包中删除版本控制。

如果操作失败，则引发异常；使用“ GetLastError（）”来检索错误信息。

VersionControlResynchPkgStatus（布尔值ClearSettings）

注意：将当前模型中记录的单个对象包的版本控制状态与版本控制提供程序报告的包状态同步。

参数：

• ClearSettings：布尔值-如果版本控制提供程序将与指定软件包关联的软件包文件报告为不受控制，则使用；如果ClearSettings为：

False，版本控制设置保持不变