RuntimeCompatibilityOptions 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
应用可以使用此类来配置任何所需的兼容性选项,以便Windows 应用服务更新中添加的更改的运行时行为。 此类仅用于设置运行时行为,不能用于查询应用的选项。
public ref class RuntimeCompatibilityOptions sealed
/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Windows.ApplicationModel.WindowsAppRuntime.RuntimeCompatibilityContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Windows.ApplicationModel.WindowsAppRuntime.RuntimeCompatibilityContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class RuntimeCompatibilityOptions final
[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.Windows.ApplicationModel.WindowsAppRuntime.RuntimeCompatibilityContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Windows.ApplicationModel.WindowsAppRuntime.RuntimeCompatibilityContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class RuntimeCompatibilityOptions
function RuntimeCompatibilityOptions()
Public NotInheritable Class RuntimeCompatibilityOptions
- 继承
- 属性
注解
可通过两种方式部署Windows 应用 SDK:依赖于框架的;或自包含的。 有关详细信息以及优点和问题,请参阅Windows 应用 SDK部署概述。
RuntimeCompatibilityOptions 类提供应用可配置的兼容性。 它旨在防止依赖于框架的部署问题,使应用能够放心地使用该选项,使其不会中断。
此外,如果在服务版本中发现兼容性问题,仍可以通过暂时禁用有问题的更改来继续前进。 即使是独立应用也可以更新到新包,确信应用可配置兼容性可确保成功更新。
RuntimeCompatibilityOptions 具有用于控制服务更改行为的 API。 还可以在应用的项目文件中设置属性,以自动使用具有指定值的新 API。
RuntimeCompatibilityOptions 配置启用了Windows 应用 SDK服务版本的更改。 默认情况下,启用所有更改,但可以使用 RuntimeCompatibilityOptions 将运行时行为锁定到指定的修补程序级别,或禁用特定更改:
- 选择修补程序级别: 可以指定要使用的服务发布行为。 例如,你的应用可以指定它想要 1.7.2 修补程序级别行为,即使安装了 1.7.3 或更高版本,也会在该修补程序级别运行Windows 应用 SDK。 此功能允许你控制应用何时获得新的修复或行为更改,即使你未使用自包含模式。
- 暂时禁用特定更改: 如果应用遇到服务更新中特定更改的问题,则可以禁用该更改,同时仍受益于该更新中的其他更改或功能。 默认情况下,所有更改都为正在使用的修补程序级别启用。 禁用更改是一种临时措施,用于在将来的Windows 应用 SDK更新中发布修补程序,或者用于在应用中实现更新。
下面是指定修补程序级别并禁用特定更改的示例:
void ApplyRuntimeCompatibilityOptions()
{
var compatibilityOptions = new RuntimeCompatibilityOptions();
compatibilityOptions.PatchLevel1 = new WindowsAppRuntimeVersion(1,7,3);
compatibilityOptions.PatchLevel2 = new WindowsAppRuntimeVersion(1,8,2);
compatibilityOptions.DisabledChanges.Add(RuntimeCompatibilityChange.SampleApiCrashFix);
compatibilityOptions.Apply();
}
必须先在进程早期应用 RuntimeCompatibilityOptions,然后才能调用任何其他Windows 应用 SDK API;或者在初始化Windows 应用运行时之后立即应用。
PatchLevel1 和 PatchLevel2 只是两个字段来设置相关的修补程序级别。 这些版本与Windows 应用运行时的任何特定版本都不匹配,也不需按特定顺序排列。 因此,将 PatchLevel1 设置为 1.8.2 和 PatchLevel2 设置为 1.7.3(例如)是有效的。 在上面的示例中,将应用更新到 1.9 时,可以选择将 PatchLevel1 更新为 1.9.3,并将 PatchLevel2 保留为 1.8.2。
在应用的项目文件中指定 RuntimeCompatibilityOptions
或者,可以使用应用的项目文件来指定修补程序级别和禁用的更改,而不是直接使用 RuntimeCompatibilityOptions。 此方法的优点是确保选项在适当时机提前应用。 下面是有关如何在项目文件中指定修补程序级别和禁用更改的示例(例如 .csproj 或 .vcxproj):
<PropertyGroup>
<WindowsAppSDKRuntimePatchLevel1>1.7.3</WindowsAppSDKRuntimePatchLevel1>
<WindowsAppSDKRuntimePatchLevel2>1.8.2</WindowsAppSDKRuntimePatchLevel2>
<WindowsAppSDKDisabledChanges>SampleApiCrashFix, OtherSampleApiCrashFix</WindowsAppSDKDisabledChanges>
</PropertyGroup>
WindowsAppSDKDisabledChanges 属性是要禁用的 RuntimeCompatibilityChange 值的逗号分隔列表。
未指定 PatchLevel 的行为
如果未指定 PatchLevel1 或 PatchLevel2 ,或者两个值都与正在使用的运行时的 major.minor 版本匹配,则运行时将使用最新的修补程序级别。 换句话说,运行时将在启用所有服务更改的情况下运行(就像不使用此 API 时Windows 应用 SDK的工作原理一样)。
构造函数
| 名称 | 说明 |
|---|---|
| RuntimeCompatibilityOptions() |
创建新的默认 RuntimeCompatibilityOptions 对象。 |
属性
| 名称 | 说明 |
|---|---|
| DisabledChanges |
获取或设置要禁用的特定服务更改的可选列表。 Windows 应用 SDK的最新稳定频道发行说明列出了可以禁用的每个更改的名称。 |
| PatchLevel1 |
获取或设置一个可选的修补程序级别,当运行时版本与 major.minor 版本匹配时要使用的。 如果你的应用未在过渡到新版本的Windows 应用 SDK的过程中,则只能设置此一个修补程序级别。 |
| PatchLevel2 |
获取或设置一个可选的修补程序级别,当运行时版本与 major.minor 版本匹配时要使用的。 此属性允许设置第二个修补程序级别,以帮助应用过渡到新版本的Windows 应用 SDK。 这是一个方便,允许在转换期间指定旧版本和新版本的修补程序级别。 转换过程中的应用应仅设置要使用的一个修补程序级别。 不允许为同一 major.minor 版本(如 1.7.3 和 1.7.4)设置这两个修补程序级别,并在调用 Apply 时生成错误。 |
方法
| 名称 | 说明 |
|---|---|
| Apply() |
将兼容性选项应用于运行时。 |