start_options.h

Overview

The start_options.h file declares the StartOptions struct and related functions.

File to include: <AbilityKit/ability_runtime/start_options.h>

Library: libability_runtime.so

System capability: SystemCapability.Ability.AbilityRuntime.Core

Since: 17

Related module: AbilityRuntime

Summary

Files

Name	Description
start_options.h	Declares the StartOptions struct. File to include: <AbilityKit/ability_runtime/start_options.h> Library: libability_runtime.so

Structs

Name	Description
AbilityRuntime_StartOptions	StartOptions struct.

Functions

Name	Description
AbilityRuntime_StartOptions* OH_AbilityRuntime_CreateStartOptions(void)	Creates the StartOptions struct required for starting the UIAbility of the current application.
AbilityRuntime_ErrorCode OH_AbilityRuntime_DestroyStartOptions(AbilityRuntime_StartOptions **startOptions)	Destroys a StartOptions struct.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowMode(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_WindowMode windowMode)	Sets the window mode for starting an ability.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowMode(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_WindowMode &windowMode)	Obtains the window mode for starting an ability.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsDisplayId(AbilityRuntime_StartOptions *startOptions, int32_t displayId)	Sets the ID of the display where the window is launched when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsDisplayId(AbilityRuntime_StartOptions *startOptions, int32_t &displayId)	Obtains the ID of the display where the window is launched when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions, bool withAnimation)	Sets whether to use animation effects when an ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWithAnimation(AbilityRuntime_StartOptions *startOptions, bool &withAnimation)	Checks whether animation effects are used when an ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowLeft(AbilityRuntime_StartOptions *startOptions, int32_t windowLeft)	Sets the left position of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowLeft(AbilityRuntime_StartOptions *startOptions, int32_t &windowLeft)	Obtains the left position of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowTop(AbilityRuntime_StartOptions *startOptions, int32_t windowTop)	Sets the top position of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowTop(AbilityRuntime_StartOptions *startOptions, int32_t &windowTop)	Obtains the top position of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t windowHeight)	Sets the height of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &windowHeight)	Obtains the height of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t windowWidth)	Sets the width of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &windowWidth)	Obtains the width of the window when the ability is started, in px.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartVisibility(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_StartVisibility startVisibility)	Sets the visibility of the window and dock bar icons when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartVisibility(AbilityRuntime_StartOptions *startOptions, AbilityRuntime_StartVisibility &startVisibility)	Obtains the visibility of the window and dock bar icons when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions startOptions, OH_PixelmapNative startWindowIcon)	Sets the startup icon of the window when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowIcon(AbilityRuntime_StartOptions startOptions, OH_PixelmapNative *startWindowIcon)	Obtains the startup icon of the window when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions startOptions, const char startWindowBackgroundColor)	Sets the background color of the window when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsStartWindowBackgroundColor(AbilityRuntime_StartOptions startOptions, char *startWindowBackgroundColor, size_t &size)	Obtains the background color of the window when the ability is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions startOptions, AbilityRuntime_SupportedWindowMode supportedWindowModes, size_t size)	Sets the window modes supported by the ability when it is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsSupportedWindowModes(AbilityRuntime_StartOptions startOptions, AbilityRuntime_SupportedWindowMode *supportedWindowModes, size_t &size)	Obtains the window modes supported by the ability when it is started.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMinWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t minWindowWidth)	Sets the minimum window width for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &minWindowWidth)	Obtains the minimum window width for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowWidth)	Sets the maximum window width for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowWidth(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowWidth)	Obtains the maximum window width for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMinWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t minWindowHeight)	Sets the minimum window height for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMinWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &minWindowHeight)	Obtains the minimum window height for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_SetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t maxWindowHeig)	Sets the maximum window height for starting the ability, in vp.
AbilityRuntime_ErrorCode OH_AbilityRuntime_GetStartOptionsMaxWindowHeight(AbilityRuntime_StartOptions *startOptions, int32_t &maxWindowHeight)	Obtains the maximum window height for starting the ability, in vp.