harmony 鸿蒙start_options.h

2025-06-12
浏览 (4)

start_options.h

概述

声明StartOptions结构体以及结构体相关函数。

引用文件：

库：libability_runtime.so

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

起始版本：17

相关模块：AbilityRuntime

汇总

文件

名称	描述
start_options.h	声明StartOptions结构体。引用文件：库：libability_runtime.so

结构体

名称	描述
AbilityRuntime_StartOptions	StartOptions数据结构。

函数

名称	描述
AbilityRuntime_StartOptions* OH_AbilityRuntime_CreateStartOptions(void)	创建启动当前应用的UIAbility所需要的StartOptions结构体。
AbilityRuntime_ErrorCode OH_AbilityRuntime_DestroyStartOptions(AbilityRuntime_StartOptions **startOptions)	销毁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时的窗口模式。
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。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions, bool withAnimation)	设置启动Ability时是否具有动画效果。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions, bool &withAnimation)	获取启动Ability时是否具有动画效果。
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。
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。
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。
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。
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栏图标的显示模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions startOptions, OH_PixelmapNative startWindowIcon)	设置启动Ability时的窗口启动图标。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions startOptions, OH_PixelmapNative *startWindowIcon)	获取启动Ability时的窗口启动图标。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions startOptions, const char startWindowBackgroundColor)	设置启动Ability时的窗口背景颜色。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions startOptions, char *startWindowBackgroundColor, size_t &size)	获取启动Ability时的窗口背景颜色。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions startOptions, AbilityRuntime_SupportedWindowMode supportedWindowModes, size_t size)	设置启动Ability时组件所支持的窗口模式。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions startOptions, AbilityRuntime_SupportedWindowMode *supportedWindowModes, size_t &size)	获取启动Ability时组件所支持的窗口模式。
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。
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。
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。
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowHeig)	设置启动Ability时的最大窗口高度，单位为vp。
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowHeight)	获取启动Ability时的最大窗口高度，单位为vp。