输入关键字搜索
开发者能力认证
鸿蒙高校创新赛
HarmonyOS 7
animation
HarmonyOS行业解决方案
layoutWeight
HarmonyOS模板&组件
bindPopup
bindsheet
CTRL+K
文档管理中心
全部文档版本说明工具设计指南与API参考开发与测试上架分发与运营问题处理与运维最佳实践行业解决方案
指南与API参考
指南
API
高级筛选
API version全部版本
设备全部
元服务API集不筛选
您当前正在浏览HarmonyOS最新文档，覆盖已发布的所有API版本，可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。
指南与API参考API参考应用框架Ability Kit（程序框架服务）C API头文件start_options.h

start_options.h

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
更新时间: 2026-09-09 06:54
复制页面
本文导读
概述
汇总
结构体
函数
函数说明
OH_AbilityRuntime_GetStartOptionsWindowModeValue()
OH_AbilityRuntime_GetStartOptionsDisplayIdValue()
OH_AbilityRuntime_GetStartOptionsWithAnimationValue()
OH_AbilityRuntime_GetStartOptionsWindowLeftValue()
OH_AbilityRuntime_GetStartOptionsWindowTopValue()
OH_AbilityRuntime_GetStartOptionsWindowHeightValue()
OH_AbilityRuntime_GetStartOptionsWindowWidthValue()
OH_AbilityRuntime_GetStartOptionsStartVisibilityValue()
OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColorValue()
OH_AbilityRuntime_GetStartOptionsSupportedWindowModesValue()
OH_AbilityRuntime_GetStartOptionsMinWindowWidthValue()
OH_AbilityRuntime_GetStartOptionsMaxWindowWidthValue()
OH_AbilityRuntime_GetStartOptionsMinWindowHeightValue()
OH_AbilityRuntime_GetStartOptionsMaxWindowHeightValue()
OH_AbilityRuntime_CreateStartOptions()
OH_AbilityRuntime_DestroyStartOptions()
OH_AbilityRuntime_SetStartOptionsWindowMode()
OH_AbilityRuntime_GetStartOptionsWindowMode()
OH_AbilityRuntime_SetStartOptionsDisplayId()
OH_AbilityRuntime_GetStartOptionsDisplayId()
OH_AbilityRuntime_SetStartOptionsWithAnimation()
OH_AbilityRuntime_GetStartOptionsWithAnimation()
OH_AbilityRuntime_SetStartOptionsWindowLeft()
OH_AbilityRuntime_GetStartOptionsWindowLeft()
OH_AbilityRuntime_SetStartOptionsWindowTop()
OH_AbilityRuntime_GetStartOptionsWindowTop()
OH_AbilityRuntime_SetStartOptionsWindowHeight()
OH_AbilityRuntime_GetStartOptionsWindowHeight()
OH_AbilityRuntime_SetStartOptionsWindowWidth()
OH_AbilityRuntime_GetStartOptionsWindowWidth()
OH_AbilityRuntime_SetStartOptionsStartVisibility()
OH_AbilityRuntime_GetStartOptionsStartVisibility()
OH_AbilityRuntime_SetStartOptionsStartWindowIcon()
OH_AbilityRuntime_GetStartOptionsStartWindowIcon()
OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor()
OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor()
OH_AbilityRuntime_SetStartOptionsSupportedWindowModes()
OH_AbilityRuntime_GetStartOptionsSupportedWindowModes()
OH_AbilityRuntime_SetStartOptionsMinWindowWidth()
OH_AbilityRuntime_GetStartOptionsMinWindowWidth()
OH_AbilityRuntime_SetStartOptionsMaxWindowWidth()
OH_AbilityRuntime_GetStartOptionsMaxWindowWidth()
OH_AbilityRuntime_SetStartOptionsMinWindowHeight()
OH_AbilityRuntime_GetStartOptionsMinWindowHeight()
OH_AbilityRuntime_SetStartOptionsMaxWindowHeight()
OH_AbilityRuntime_GetStartOptionsMaxWindowHeight()
展开章节

概述

提供应用启动参数数据结构AbilityRuntime_StartOptions以及设置和获取相关函数。

引用文件： <AbilityKit/ability_runtime/start_options.h>

库： libability_runtime.so

系统能力： SystemCapability.Ability.AbilityRuntime.Core

起始版本： 17

相关模块： AbilityRuntime

汇总

结构体

展开
名称 typedef关键字 描述
AbilityRuntime_StartOptions AbilityRuntime_StartOptions StartOptions数据结构。

函数

展开
名称 描述
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowModeValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_WindowMode *windowMode) 获取启动Ability时的窗口模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsDisplayIdValue(AbilityRuntime_StartOptions *startOptions, int32_t *displayId) 获取启动Ability时窗口所在的屏幕ID。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimationValue(AbilityRuntime_StartOptions *startOptions, bool *withAnimation) 获取启动Ability时是否具有动画效果。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowLeftValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowLeft) 获取启动Ability时的窗口左侧位置，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowTopValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowTop) 获取启动Ability时的窗口顶部位置，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowHeight) 获取启动Ability时的窗口高度，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowWidth) 获取启动Ability时的窗口宽度，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartVisibilityValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_StartVisibility *startVisibility) 获取启动Ability时窗口和dock栏图标的显示模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColorValue(AbilityRuntime_StartOptions *startOptions, char **startWindowBackgroundColor, size_t *size) 获取启动Ability时的窗口背景颜色。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModesValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode **supportedWindowModes, size_t *size) 获取启动Ability时的组件所支持的窗口模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *minWindowWidth) 获取启动Ability时的窗口最小宽度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *maxWindowWidth) 获取启动Ability时的窗口最大宽度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *minWindowHeight) 获取启动Ability时的窗口最小高度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *maxWindowHeight) 获取启动Ability时的窗口最大高度，单位为vp。
AbilityRuntime_StartOptions* OH_AbilityRuntime_CreateStartOptions(void) 创建AbilityRuntime_StartOptions对象。
AbilityRuntime_ErrorCode OH_AbilityRuntime_DestroyStartOptions(AbilityRuntime_StartOptions **startOptions) 销毁AbilityRuntime_StartOptions对象。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowMode(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_WindowMode windowMode) 设置启动Ability时的窗口模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowMode(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_WindowMode &windowMode) 获取启动Ability时的窗口模式。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowModeValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_WindowMode *windowMode)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsDisplayId(AbilityRuntime_StartOptions *startOptions,int32_t displayId) 设置启动Ability时窗口所在的屏幕ID。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsDisplayId(AbilityRuntime_StartOptions *startOptions,int32_t &displayId) 获取启动Ability时窗口所在的屏幕ID。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsDisplayIdValue(AbilityRuntime_StartOptions *startOptions, int32_t *displayId)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions,bool withAnimation) 设置启动Ability时是否具有动画效果。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions,bool &withAnimation) 获取启动Ability时是否具有动画效果。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimationValue(AbilityRuntime_StartOptions *startOptions, bool *withAnimation)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowLeft(AbilityRuntime_StartOptions *startOptions,int32_t windowLeft) 设置启动Ability时的窗口左侧位置，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowLeft(AbilityRuntime_StartOptions *startOptions,int32_t &windowLeft) 获取启动Ability时的窗口左侧位置，单位为px。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowLeftValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowLeft)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowTop(AbilityRuntime_StartOptions *startOptions,int32_t windowTop) 设置启动Ability时的窗口顶部位置，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowTop(AbilityRuntime_StartOptions *startOptions,int32_t &windowTop) 获取启动Ability时的窗口顶部位置，单位为px。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowTopValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowTop)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowHeight(AbilityRuntime_StartOptions *startOptions,int32_t windowHeight) 设置启动Ability时的窗口高度，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowHeight(AbilityRuntime_StartOptions *startOptions,int32_t &windowHeight) 获取启动Ability时的窗口高度，单位为px。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowHeight)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowWidth(AbilityRuntime_StartOptions *startOptions,int32_t windowWidth) 设置启动Ability时的窗口宽度，单位为px。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowWidth(AbilityRuntime_StartOptions *startOptions,int32_t &windowWidth) 获取启动Ability时的窗口宽度，单位为px。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowWidth)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartVisibility(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_StartVisibility startVisibility) 设置启动Ability时窗口和dock栏图标的显示模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartVisibility(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_StartVisibility &startVisibility) 获取启动Ability时窗口和dock栏图标的显示模式。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartVisibilityValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_StartVisibility *startVisibility)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions *startOptions,OH_PixelmapNative *startWindowIcon) 设置启动Ability时的窗口启动图标。图片数据大小限制为600MB。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions *startOptions,OH_PixelmapNative **startWindowIcon) 获取启动Ability时的窗口启动图标。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions *startOptions, const char *startWindowBackgroundColor) 设置启动Ability时的窗口背景颜色。如果未设置该字段，则默认采用module.json5配置文件中abilities标签的startWindowBackground字段的配置。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions *startOptions, char **startWindowBackgroundColor, size_t &size) 获取启动Ability时的窗口背景颜色。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColorValue(AbilityRuntime_StartOptions *startOptions, char **startWindowBackgroundColor, size_t *size)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode *supportedWindowModes,size_t size) 设置启动Ability时的组件所支持的窗口模式。如果未配置该字段，则默认采用该UIAbility对应的module.json5配置文件中abilities标签的supportWindowMode字段取值。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode **supportedWindowModes,size_t &size) 获取启动Ability时的组件所支持的窗口模式。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModesValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode **supportedWindowModes, size_t *size)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMinWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t minWindowWidth) 设置启动Ability时的窗口最小宽度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &minWindowWidth) 获取启动Ability时的窗口最小宽度，单位为vp。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *minWindowWidth)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowWidth) 设置启动Ability时的窗口最大宽度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowWidth) 获取启动Ability时的窗口最大宽度，单位为vp。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *maxWindowWidth)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMinWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t minWindowHeight) 设置启动Ability时的窗口最小高度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &minWindowHeight) 获取启动Ability时的窗口最小高度，单位为vp。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *minWindowHeight)。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowHeight) 设置启动Ability时的窗口最大高度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowHeight) 获取启动Ability时的窗口最大高度，单位为vp。仅支持C++编译；若需在C语言环境中调用，请使用AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *maxWindowHeight)。

函数说明

OH_AbilityRuntime_GetStartOptionsWindowModeValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowModeValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_WindowMode *windowMode)

描述

获取启动Ability时的窗口模式。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_WindowMode *windowMode 指向启动Ability时窗口模式的指针。取值范围参见AbilityRuntime_WindowMode。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者windowMode为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_WindowMode windowMode = ABILITY_RUNTIME_WINDOW_MODE_UNDEFINED;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowModeValue(options, &windowMode);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsDisplayIdValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsDisplayIdValue(AbilityRuntime_StartOptions *startOptions, int32_t *displayId)

描述

获取启动Ability时窗口所在的屏幕ID。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *displayId 指向启动Ability时窗口所在屏幕ID的指针。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者displayId为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t displayId = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsDisplayIdValue(options, &displayId);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsWithAnimationValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimationValue(AbilityRuntime_StartOptions *startOptions, bool *withAnimation)

描述

获取启动Ability时是否具有动画效果。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
bool *withAnimation 指向启动Ability时是否具有动画效果的指针。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者withAnimation为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     bool withAnimation = false;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWithAnimationValue(options, &withAnimation);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsWindowLeftValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowLeftValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowLeft)

描述

获取启动Ability时的窗口左侧位置，单位为px。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *windowLeft 指向启动Ability时窗口左侧位置的指针，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者windowLeft为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowLeft = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowLeftValue(options, &windowLeft);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsWindowTopValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowTopValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowTop)

描述

获取启动Ability时的窗口顶部位置，单位为px。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *windowTop 指向启动Ability时窗口顶部位置的指针，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者windowTop为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowTop = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowTopValue(options, &windowTop);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsWindowHeightValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowHeight)

描述

获取启动Ability时的窗口高度，单位为px。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *windowHeight 指向启动Ability时窗口高度的指针，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者windowHeight为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowHeight = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowHeightValue(options, &windowHeight);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsWindowWidthValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *windowWidth)

描述

获取启动Ability时的窗口宽度，单位为px。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *windowWidth 指向启动Ability时窗口宽度的指针，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者windowWidth为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowWidth = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowWidthValue(options, &windowWidth);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsStartVisibilityValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartVisibilityValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_StartVisibility *startVisibility)

描述

获取启动Ability时窗口和dock栏图标的显示模式。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_StartVisibility *startVisibility 指向启动Ability时窗口和dock栏图标显示模式的指针。取值范围参见AbilityRuntime_StartVisibility。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者startVisibility为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_StartVisibility visibility = ABILITY_RUNTIME_HIDE_UPON_START;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsStartVisibilityValue(options, &visibility);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColorValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColorValue(AbilityRuntime_StartOptions *startOptions, char **startWindowBackgroundColor, size_t *size)

描述

获取启动Ability时的窗口背景颜色。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
char **startWindowBackgroundColor 指向获取到的窗口背景颜色UTF-8字符串指针的二级指针，不能为空，且调用前必须指向空指针。固定为ARGB格式，如：#E5FFFFFF。使用完毕后，需要调用free释放。
size_t *size 指向获取到的窗口背景颜色字符串长度的指针，不能为空，不包含字符串结尾的空字符。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示任意参数无效。

在返回ABILITY_RUNTIME_ERROR_CODE_INTERNAL时，表示开发者无法恢复的内部错误，比如内部调用malloc错误。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <stdlib.h>
  2. 

  3. #include <AbilityKit/ability_runtime/start_options.h>
  4. 

  5. void demo()
  6. {
  7.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  8.     if (options == NULL) {
  9.         // 记录错误日志以及其他业务处理
  10.         return;
  11.     }
  12. 

  13.     char *startWindowBackgroundColor = NULL;
  14.     size_t size = 0;
  15.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColorValue(options,
  16.         &startWindowBackgroundColor, &size);
  17.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  18.         // 记录错误日志以及其他业务处理
  19.     }
  20. 

  21.     if (startWindowBackgroundColor != NULL) {
  22.         // 销毁startWindowBackgroundColor，防止内存泄漏
  23.         free(startWindowBackgroundColor);
  24.         startWindowBackgroundColor = NULL;
  25.     }
  26. 

  27.     // 销毁options，防止内存泄漏
  28.     OH_AbilityRuntime_DestroyStartOptions(&options);
  29. }

OH_AbilityRuntime_GetStartOptionsSupportedWindowModesValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModesValue(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode **supportedWindowModes, size_t *size)

描述

获取启动Ability时的组件所支持的窗口模式。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_SupportedWindowMode **supportedWindowModes 指向获取到的组件所支持窗口模式数组指针的二级指针，不能为空，且调用前必须指向空指针。取值范围参见AbilityRuntime_SupportedWindowMode。使用完毕后，需要调用free释放。
size_t *size 指向获取到的组件所支持窗口模式数量的指针，不能为空。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示任意参数无效。

在返回ABILITY_RUNTIME_ERROR_CODE_INTERNAL时，表示开发者无法恢复的内部错误，比如内部调用malloc错误。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <stdlib.h>
  2. 

  3. #include <AbilityKit/ability_runtime/start_options.h>
  4. 

  5. void demo()
  6. {
  7.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  8.     if (options == NULL) {
  9.         // 记录错误日志以及其他业务处理
  10.         return;
  11.     }
  12. 

  13.     AbilityRuntime_SupportedWindowMode *supportedWindowModes = NULL;
  14.     size_t size = 0;
  15.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsSupportedWindowModesValue(options,
  16.         &supportedWindowModes, &size);
  17.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  18.         // 记录错误日志以及其他业务处理
  19.     }
  20. 

  21.     if (supportedWindowModes != NULL) {
  22.         // 销毁supportedWindowModes，防止内存泄漏
  23.         free(supportedWindowModes);
  24.     }
  25. 

  26.     // 销毁options，防止内存泄漏
  27.     OH_AbilityRuntime_DestroyStartOptions(&options);
  28. }

OH_AbilityRuntime_GetStartOptionsMinWindowWidthValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *minWindowWidth)

描述

获取启动Ability时的窗口最小宽度，单位为vp。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *minWindowWidth 指向启动Ability时窗口最小宽度的指针，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者minWindowWidth为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t minWindowWidth = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMinWindowWidthValue(options, &minWindowWidth);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsMaxWindowWidthValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowWidthValue(AbilityRuntime_StartOptions *startOptions, int32_t *maxWindowWidth)

描述

获取启动Ability时的窗口最大宽度，单位为vp。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *maxWindowWidth 指向启动Ability时窗口最大宽度的指针，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者maxWindowWidth为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t maxWindowWidth = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMaxWindowWidthValue(options, &maxWindowWidth);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsMinWindowHeightValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *minWindowHeight)

描述

获取启动Ability时的窗口最小高度，单位为vp。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *minWindowHeight 指向启动Ability时窗口最小高度的指针，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者minWindowHeight为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t minWindowHeight = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMinWindowHeightValue(options, &minWindowHeight);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_GetStartOptionsMaxWindowHeightValue()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeightValue(AbilityRuntime_StartOptions *startOptions, int32_t *maxWindowHeight)

描述

获取启动Ability时的窗口最大高度，单位为vp。

起始版本： 26.0.0

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t *maxWindowHeight 指向启动Ability时窗口最大高度的指针，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者maxWindowHeight为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == NULL) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t maxWindowHeight = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMaxWindowHeightValue(options, &maxWindowHeight);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_CreateStartOptions()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_StartOptions* OH_AbilityRuntime_CreateStartOptions(void)

描述

创建AbilityRuntime_StartOptions对象。

起始版本： 17

返回：

展开
类型 说明
AbilityRuntime_StartOptions* 返回指针类型AbilityRuntime_StartOptions对象。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void createStartOptionsTest()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     // 销毁options，防止内存泄漏
  12.     OH_AbilityRuntime_DestroyStartOptions(&options);
  13. }

OH_AbilityRuntime_DestroyStartOptions()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_DestroyStartOptions(AbilityRuntime_StartOptions **startOptions)

描述

销毁AbilityRuntime_StartOptions对象。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions **startOptions 需要销毁的AbilityRuntime_StartOptions对象。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void destroyStartOptionsTest()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     // 销毁options，防止内存泄漏
  12.     OH_AbilityRuntime_DestroyStartOptions(&options);
  13. }

OH_AbilityRuntime_SetStartOptionsWindowMode()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowMode(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_WindowMode windowMode)

描述

设置启动Ability时的窗口模式。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_WindowMode windowMode 启动Ability时的窗口模式。取值范围参见AbilityRuntime_WindowMode。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空或者WindowMode无效。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsWindowMode(options,
  12.         ABILITY_RUNTIME_WINDOW_MODE_FULL_SCREEN);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsWindowMode()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowMode(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_WindowMode &windowMode)

描述

获取启动Ability时的窗口模式。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_WindowMode windowMode 启动Ability时的窗口模式。取值范围参见AbilityRuntime_WindowMode。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_WindowMode windowMode = ABILITY_RUNTIME_WINDOW_MODE_UNDEFINED;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowMode(options, windowMode);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsDisplayId()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsDisplayId(AbilityRuntime_StartOptions *startOptions,int32_t displayId)

描述

设置启动Ability时窗口所在的屏幕ID。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t displayId 启动Ability时窗口所在的屏幕ID。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsDisplayId(options, 1);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15.     // 销毁options，防止内存泄漏
  16.     OH_AbilityRuntime_DestroyStartOptions(&options);
  17. }

OH_AbilityRuntime_GetStartOptionsDisplayId()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsDisplayId(AbilityRuntime_StartOptions *startOptions,int32_t &displayId)

描述

获取启动Ability时窗口所在的屏幕ID。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &displayId 启动Ability时窗口所在的屏幕ID。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t displayId = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsDisplayId(options, displayId);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsWithAnimation()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions,bool withAnimation)

描述

设置启动Ability时是否具有动画效果。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
bool withAnimation

启动Ability时是否具有动画效果。

true表示启动Ability时具有动画效果；false表示启动Ability时不具有动画效果。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsWithAnimation(options, true);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15.     // 销毁options，防止内存泄漏
  16.     OH_AbilityRuntime_DestroyStartOptions(&options);
  17. }

OH_AbilityRuntime_GetStartOptionsWithAnimation()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions,bool &withAnimation)

描述

获取启动Ability时是否具有动画效果。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
bool &withAnimation

启动Ability时是否具有动画效果。

true表示启动Ability时具有动画效果；false表示启动Ability时不具有动画效果。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     bool withAnimation = false;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWithAnimation(options, withAnimation);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsWindowLeft()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowLeft(AbilityRuntime_StartOptions *startOptions,int32_t windowLeft)

描述

设置启动Ability时的窗口左侧位置，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t windowLeft 启动Ability时的窗口左侧位置，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsWindowLeft(options, 200);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15.     // 销毁options，防止内存泄漏
  16.     OH_AbilityRuntime_DestroyStartOptions(&options);
  17. }

OH_AbilityRuntime_GetStartOptionsWindowLeft()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowLeft(AbilityRuntime_StartOptions *startOptions,int32_t &windowLeft)

描述

获取启动Ability时的窗口左侧位置，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &windowLeft 启动Ability时的窗口左侧位置，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowLeft = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowLeft(options, windowLeft);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsWindowTop()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowTop(AbilityRuntime_StartOptions *startOptions,int32_t windowTop)

描述

设置启动Ability时的窗口顶部位置，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t windowTop 启动Ability时的窗口顶部位置，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsWindowTop(options, 500);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15.     // 销毁options，防止内存泄漏
  16.     OH_AbilityRuntime_DestroyStartOptions(&options);
  17. }

OH_AbilityRuntime_GetStartOptionsWindowTop()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowTop(AbilityRuntime_StartOptions *startOptions,int32_t &windowTop)

描述

获取启动Ability时的窗口顶部位置，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &windowTop 启动Ability时的窗口顶部位置，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowTop = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowTop(options, windowTop);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsWindowHeight()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowHeight(AbilityRuntime_StartOptions *startOptions,int32_t windowHeight)

描述

设置启动Ability时的窗口高度，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t windowHeight 启动Ability时的窗口高度，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsWindowHeight(options, 500);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15.     // 销毁options，防止内存泄漏
  16.     OH_AbilityRuntime_DestroyStartOptions(&options);
  17. }

OH_AbilityRuntime_GetStartOptionsWindowHeight()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowHeight(AbilityRuntime_StartOptions *startOptions,int32_t &windowHeight)

描述

获取启动Ability时的窗口高度，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &windowHeight 启动Ability时的窗口高度，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowHeight = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowHeight(options, windowHeight);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsWindowWidth()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowWidth(AbilityRuntime_StartOptions *startOptions,int32_t windowWidth)

描述

设置启动Ability时的窗口宽度，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t windowWidth 启动Ability时的窗口宽度，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsWindowWidth(options, 500);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15.     // 销毁options，防止内存泄漏
  16.     OH_AbilityRuntime_DestroyStartOptions(&options);
  17. }

OH_AbilityRuntime_GetStartOptionsWindowWidth()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowWidth(AbilityRuntime_StartOptions *startOptions,int32_t &windowWidth)

描述

获取启动Ability时的窗口宽度，单位为px。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &windowWidth 启动Ability时的窗口宽度，单位为px。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t windowWidth = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsWindowWidth(options, windowWidth);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsStartVisibility()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartVisibility(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_StartVisibility startVisibility)

描述

设置启动Ability时窗口和dock栏图标的显示模式。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions StartOptions结构体。
AbilityRuntime_StartVisibility startVisibility 需要设置的显示模式。取值范围参见AbilityRuntime_StartVisibility。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示设置成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或startVisibility取值不在枚举类AbilityRuntime_StartVisibility中。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_StartVisibility visibility = AbilityRuntime_StartVisibility::ABILITY_RUNTIME_SHOW_UPON_START;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsStartVisibility(options, visibility);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsStartVisibility()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartVisibility(AbilityRuntime_StartOptions *startOptions,AbilityRuntime_StartVisibility &startVisibility)

描述

获取启动Ability时窗口和dock栏图标的显示模式。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions StartOptions结构体。
AbilityRuntime_StartVisibility &startVisibility 获取到的显示模式。取值范围参见AbilityRuntime_StartVisibility。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示获取成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或startVisibility未被设置。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_StartVisibility visibility;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsStartVisibility(options, visibility);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_SetStartOptionsStartWindowIcon()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions *startOptions,OH_PixelmapNative *startWindowIcon)

描述

设置启动Ability时的窗口启动图标。图片数据大小限制为600MB。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
OH_PixelmapNative *startWindowIcon 启动Ability时的窗口启动图标。图片数据大小限制为600MB。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者startWindowIcon为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     uint8_t data[96];
  6.     size_t dataSize = 96;
  7.     for (int i = 0; i < dataSize; i++) {
  8.         data[i] = i + 1;
  9.     }
  10. 

  11.     // 创建参数结构体实例，并设置参数
  12.     OH_Pixelmap_InitializationOptions *createOpts = nullptr;
  13.     OH_PixelmapInitializationOptions_Create(&createOpts);
  14.     OH_PixelmapInitializationOptions_SetWidth(createOpts, 6);
  15.     OH_PixelmapInitializationOptions_SetHeight(createOpts, 4);
  16.     OH_PixelmapInitializationOptions_SetPixelFormat(createOpts, PIXEL_FORMAT_RGBA_8888);
  17.     OH_PixelmapInitializationOptions_SetAlphaType(createOpts, PIXELMAP_ALPHA_TYPE_UNKNOWN);
  18. 

  19.     // 创建Pixelmap实例
  20.     OH_PixelmapNative *startWindowIcon = nullptr;
  21.     Image_ErrorCode errCode = OH_PixelmapNative_CreatePixelmap(data, dataSize, createOpts, &startWindowIcon);
  22.     if (errCode != IMAGE_SUCCESS) {
  23.         // 记录错误日志以及其他业务处理
  24. 

  25.         // 销毁createOpts，防止内存泄漏
  26.         OH_PixelmapInitializationOptions_Release(createOpts);
  27.         return;
  28.     }
  29. 

  30.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  31.     if (options == nullptr) {
  32.         // 记录错误日志以及其他业务处理
  33. 

  34.         // 销毁createOpts，防止内存泄漏
  35.         OH_PixelmapInitializationOptions_Release(createOpts);
  36. 

  37.         // 销毁startWindowIcon，防止内存泄漏
  38.         OH_PixelmapNative_Release(startWindowIcon);
  39.         return;
  40.     }
  41. 

  42.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsStartWindowIcon(options, startWindowIcon);
  43.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  44.         // 记录错误日志以及其他业务处理
  45.     }
  46.     // 销毁createOpts，防止内存泄漏
  47.     OH_PixelmapInitializationOptions_Release(createOpts);
  48. 

  49.     // 销毁startWindowIcon，防止内存泄漏
  50.     OH_PixelmapNative_Release(startWindowIcon);
  51. 

  52.     // 销毁options，防止内存泄漏
  53.     OH_AbilityRuntime_DestroyStartOptions(&options);
  54. }

OH_AbilityRuntime_GetStartOptionsStartWindowIcon()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions *startOptions,OH_PixelmapNative **startWindowIcon)

描述

获取启动Ability时的窗口启动图标。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
OH_PixelmapNative **startWindowIcon 启动Ability时的窗口启动图标。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者startWindowIcon没有设置为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     OH_PixelmapNative *startWindowIcon = nullptr;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsStartWindowIcon(options, &startWindowIcon);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁startWindowIcon，防止内存泄漏
  18.     OH_PixelmapNative_Release(startWindowIcon);
  19. 

  20.     // 销毁options，防止内存泄漏
  21.     OH_AbilityRuntime_DestroyStartOptions(&options);
  22. }

OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions *startOptions, const char *startWindowBackgroundColor)

描述

设置启动Ability时的窗口背景颜色。如果未设置，则默认采用module.json5配置文件中abilities标签的startWindowBackground字段的配置。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
const char *startWindowBackgroundColor 启动Ability时的窗口背景颜色。固定为ARGB格式，如：#E5FFFFFF。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者startWindowBackgroundColor为空指针。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor(options, "#00000000");
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15. 

  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions *startOptions, char **startWindowBackgroundColor, size_t &size)

描述

获取启动Ability时的窗口背景颜色。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
char **startWindowBackgroundColor 启动Ability时的窗口背景颜色。固定为ARGB格式，如：#E5FFFFFF。
size_t &size 获取到的窗口背景颜色的大小。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示startOptions为空，或者startWindowBackgroundColor没有置为空指针。

在返回ABILITY_RUNTIME_ERROR_CODE_INTERNAL时，表示开发者无法恢复的内部错误，比如内部调用malloc错误，或者字符串拷贝函数出错。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <cstdlib>
  2. 

  3. #include <AbilityKit/ability_runtime/start_options.h>
  4. 

  5. void demo()
  6. {
  7.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  8.     if (options == nullptr) {
  9.         // 记录错误日志以及其他业务处理
  10.         return;
  11.     }
  12. 

  13.     char *startWindowBackgroundColor = nullptr;
  14.     size_t size = 0;
  15.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor(options,
  16.         &startWindowBackgroundColor, size);
  17.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  18.         // 记录错误日志以及其他业务处理
  19.     }
  20. 

  21.     if (startWindowBackgroundColor != nullptr) {
  22.         // 销毁startWindowBackgroundColor，防止内存泄漏
  23.         free(startWindowBackgroundColor);
  24.         startWindowBackgroundColor = nullptr;
  25.     }
  26. 

  27.     // 销毁options，防止内存泄漏
  28.     OH_AbilityRuntime_DestroyStartOptions(&options);
  29. }

OH_AbilityRuntime_SetStartOptionsSupportedWindowModes()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode *supportedWindowModes,size_t size)

描述

设置启动Ability时的组件所支持的窗口模式。如果未配置该字段，则默认采用该UIAbility对应的module.json5配置文件中，abilities标签的supportWindowMode字段的取值。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_SupportedWindowMode *supportedWindowModes 启动Ability时的组件所支持的窗口模式。取值范围参见AbilityRuntime_SupportedWindowMode。
size_t size 组件所支持的窗口模式大小。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions或者SupportedWindowModes为空，或者Size为0。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     size_t supportedWindowModesSize = 3;
  12.     AbilityRuntime_SupportedWindowMode supportedWindowModes[3] = {
  13.         ABILITY_RUNTIME_SUPPORTED_WINDOW_MODE_FULL_SCREEN,
  14.         ABILITY_RUNTIME_SUPPORTED_WINDOW_MODE_SPLIT,
  15.         ABILITY_RUNTIME_SUPPORTED_WINDOW_MODE_FLOATING,
  16.     };
  17.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsSupportedWindowModes(options,
  18.         supportedWindowModes, supportedWindowModesSize);
  19.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  20.         // 记录错误日志以及其他业务处理
  21.     }
  22. 

  23.     // 销毁options，防止内存泄漏
  24.     OH_AbilityRuntime_DestroyStartOptions(&options);
  25. }

OH_AbilityRuntime_GetStartOptionsSupportedWindowModes()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_SupportedWindowMode **supportedWindowModes,size_t &size)

描述

获取启动Ability时的组件所支持的窗口模式。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
AbilityRuntime_SupportedWindowMode **supportedWindowModes 启动Ability时的组件所支持的窗口模式。取值范围参见AbilityRuntime_SupportedWindowMode。
size_t &size 组件所支持的窗口模式大小。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空，或者SupportWindowMode没有置为空指针。

在返回ABILITY_RUNTIME_ERROR_CODE_INTERNAL时，表示开发者无法恢复的内部错误，比如内部调用malloc错误。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <cstdlib>
  2. 

  3. #include <AbilityKit/ability_runtime/start_options.h>
  4. 

  5. void demo()
  6. {
  7.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  8.     if (options == nullptr) {
  9.         // 记录错误日志以及其他业务处理
  10.         return;
  11.     }
  12. 

  13.     AbilityRuntime_SupportedWindowMode *supportedWindowModes = nullptr;
  14.     size_t size = 0;
  15.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsSupportedWindowModes(options,
  16.         &supportedWindowModes, size);
  17.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  18.         // 记录错误日志以及其他业务处理
  19.     }
  20. 

  21.     if (supportedWindowModes != nullptr) {
  22.         // 销毁supportedWindowModes，防止内存泄漏
  23.         free(supportedWindowModes);
  24.     }
  25. 

  26.     // 销毁options，防止内存泄漏
  27.     OH_AbilityRuntime_DestroyStartOptions(&options);
  28. }

OH_AbilityRuntime_SetStartOptionsMinWindowWidth()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMinWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t minWindowWidth)

描述

设置启动Ability时的窗口最小宽度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t minWindowWidth 启动Ability时的窗口最小宽度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsMinWindowWidth(options, 100);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15. 

  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsMinWindowWidth()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &minWindowWidth)

描述

获取启动Ability时的窗口最小宽度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &minWindowWidth 启动Ability时的窗口最小宽度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t minWindowWidth = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMinWindowWidth(options, minWindowWidth);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_SetStartOptionsMaxWindowWidth()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowWidth)

描述

设置启动Ability时的窗口最大宽度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t maxWindowWidth 启动Ability时的窗口最大宽度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsMaxWindowWidth(options, 100);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15. 

  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsMaxWindowWidth()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowWidth)

描述

获取启动Ability时的窗口最大宽度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &maxWindowWidth 启动Ability时的窗口最大宽度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t maxWindowWidth = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMaxWindowWidth(options, maxWindowWidth);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_SetStartOptionsMinWindowHeight()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMinWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t minWindowHeight)

描述

设置启动Ability时的窗口最小高度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t minWindowHeight 启动Ability时的窗口最小高度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsMinWindowHeight(options, 100);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15. 

  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsMinWindowHeight()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &minWindowHeight)

描述

获取启动Ability时的窗口最小高度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &minWindowHeight 启动Ability时的窗口最小高度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t minWindowHeight = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMinWindowHeight(options, minWindowHeight);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }

OH_AbilityRuntime_SetStartOptionsMaxWindowHeight()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowHeight)

描述

设置启动Ability时的窗口最大高度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t maxWindowHeight 启动Ability时的窗口最大高度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_SetStartOptionsMaxWindowHeight(options, 100);
  12.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  13.         // 记录错误日志以及其他业务处理
  14.     }
  15. 

  16.     // 销毁options，防止内存泄漏
  17.     OH_AbilityRuntime_DestroyStartOptions(&options);
  18. }

OH_AbilityRuntime_GetStartOptionsMaxWindowHeight()

Phone17+PC/2in117+Tablet17+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowHeight)

描述

获取启动Ability时的窗口最大高度，单位为vp。

起始版本： 17

参数：

展开
参数项 描述
AbilityRuntime_StartOptions *startOptions AbilityRuntime_StartOptions对象。
int32_t &maxWindowHeight 启动Ability时的窗口最大高度，单位为vp。

返回：

展开
类型 说明
AbilityRuntime_ErrorCode

在返回ABILITY_RUNTIME_ERROR_CODE_NO_ERROR时，表示接口调用成功。

在返回ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID时，表示StartOptions为空。

示例代码：

收起
自动换行
深色代码主题
复制
  1. #include <AbilityKit/ability_runtime/start_options.h>
  2. 

  3. void demo()
  4. {
  5.     AbilityRuntime_StartOptions* options = OH_AbilityRuntime_CreateStartOptions();
  6.     if (options == nullptr) {
  7.         // 记录错误日志以及其他业务处理
  8.         return;
  9.     }
  10. 

  11.     int32_t maxWindowHeight = 0;
  12.     AbilityRuntime_ErrorCode err = OH_AbilityRuntime_GetStartOptionsMaxWindowHeight(options, maxWindowHeight);
  13.     if (err != ABILITY_RUNTIME_ERROR_CODE_NO_ERROR) {
  14.         // 记录错误日志以及其他业务处理
  15.     }
  16. 

  17.     // 销毁options，防止内存泄漏
  18.     OH_AbilityRuntime_DestroyStartOptions(&options);
  19. }
native_interface_bundle.h
want.h
简体中文
华为开发者联盟 版权所有 ©2026
问题反馈
使用条款
华为开发者联盟用户协议
关于华为开发者联盟与隐私的声明
Cookies
开源软件声明