modular_object_extension_ability.h

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

更新时间: 2026-08-29 09:41

概述

声明ModularObjectExtensionAbility实例的接口，包括注册生命周期回调函数和获取上下文等能力，适用于处理ModularObjectExtensionAbility生命周期的场景。

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

库： libability_runtime.so

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

起始版本： 26.0.0

相关模块： AbilityRuntime

汇总

结构体

展开

名称	typedef关键字	描述
OH_AbilityRuntime_ModularObjectExtensionInstance	OH_AbilityRuntime_ModObjExtensionInstance	表示ModularObjectExtensionAbility实例。
OH_AbilityRuntime_ModObjExtensionInstance*	OH_AbilityRuntime_ModObjExtensionInstanceHandle	定义指向OH_AbilityRuntime_ModObjExtensionInstance的指针。

函数

展开

名称	typedef关键字	描述
typedef void (OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, AbilityBase_Want want)	OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc	ModularObjectExtensionAbility创建时触发的回调函数类型，用于初始化。
typedef void (*OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance)	OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc	ModularObjectExtensionAbility销毁前触发的回调函数类型。
typedef OHIPCRemoteStub* (OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, AbilityBase_Want want)	OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc	ModularObjectExtensionAbility被连接时触发的回调函数类型。
typedef void (*OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance)	OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc	当前ModularObjectExtensionAbility的所有连接都断开时触发的回调函数类型。
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnCreateFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc onCreateFunc)	-	向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc回调函数。
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnDestroyFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc onDestroyFunc)	-	向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc回调函数。
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnConnectFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc onConnectFunc)	-	向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc回调函数。
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnDisconnectFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc onDisconnectFunc)	-	向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc回调函数。
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_GetContextFromInstance(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionContextHandle* context)	-	从ModularObjectExtensionAbility实例中获取ExtensionAbility上下文。
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_GetInstanceFromBase(AbilityRuntime_ExtensionInstanceHandle baseExtensionInstance, OH_AbilityRuntime_ModObjExtensionInstanceHandle* modObjExtensionInstance)	-	从基础ExtensionAbility实例中获取ModularObjectExtensionAbility实例。

函数说明

OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
typedef void (*OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, AbilityBase_Want *want)

描述

ModularObjectExtensionAbility创建时触发的回调函数，用于初始化。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
AbilityBase_Want *want	表示创建ModularObjectExtensionAbility时的Want信息。详细内容参考AbilityBase_Want。

OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
typedef void (*OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance)

描述

ModularObjectExtensionAbility销毁前触发的回调函数。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。

OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
typedef OHIPCRemoteStub* (*OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, AbilityBase_Want *want)

描述

ModularObjectExtensionAbility被连接时触发的回调函数，需返回OHIPCRemoteStub对象以提供跨进程通信服务。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
AbilityBase_Want *want	表示连接ModularObjectExtensionAbility时的Want信息。详细内容参考AbilityBase_Want。

返回：

展开

类型	说明
OHIPCRemoteStub*	返回IPC远程桩对象，用于跨进程通信服务。

OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
typedef void (*OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc)(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance)

描述

当前ModularObjectExtensionAbility的所有客户端连接都断开时触发的回调函数。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。

OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnCreateFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnCreateFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc onCreateFunc)

描述

向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc回调函数。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
OH_AbilityRuntime_ModObjExtensionAbility_OnCreateFunc onCreateFunc	表示待注册的OnCreate回调函数。

返回：

展开

类型	说明
AbilityRuntime_ErrorCode	返回特定的错误码。 ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。 ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

类型

说明

AbilityRuntime_ErrorCode

返回特定的错误码。

ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。

ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnDestroyFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnDestroyFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc onDestroyFunc)

描述

向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc回调函数。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
OH_AbilityRuntime_ModObjExtensionAbility_OnDestroyFunc onDestroyFunc	表示待注册的OnDestroy回调函数。

返回：

展开

类型	说明
AbilityRuntime_ErrorCode	返回特定的错误码。 ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。 ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

类型

说明

AbilityRuntime_ErrorCode

返回特定的错误码。

ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。

ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnConnectFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnConnectFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc onConnectFunc)

描述

向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc回调函数。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
OH_AbilityRuntime_ModObjExtensionAbility_OnConnectFunc onConnectFunc	表示待注册的OnConnect回调函数。

返回：

展开

类型	说明
AbilityRuntime_ErrorCode	返回特定的错误码。 ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。 ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

类型

说明

AbilityRuntime_ErrorCode

返回特定的错误码。

ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。

ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnDisconnectFunc()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_RegisterOnDisconnectFunc(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc onDisconnectFunc)

描述

向OH_AbilityRuntime_ModObjExtensionInstance注册OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc回调函数。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
OH_AbilityRuntime_ModObjExtensionAbility_OnDisconnectFunc onDisconnectFunc	表示待注册的OnDisconnect回调函数。

返回：

展开

类型	说明
AbilityRuntime_ErrorCode	返回特定的错误码。 ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。 ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

类型

说明

AbilityRuntime_ErrorCode

返回特定的错误码。

ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。

ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

OH_AbilityRuntime_ModObjExtensionAbility_GetContextFromInstance()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_GetContextFromInstance(OH_AbilityRuntime_ModObjExtensionInstanceHandle instance, OH_AbilityRuntime_ModObjExtensionContextHandle* context)

描述

从ModularObjectExtensionAbility实例中获取ExtensionAbility上下文。

起始版本： 26.0.0

参数：

展开

参数项	描述
OH_AbilityRuntime_ModObjExtensionInstanceHandle instance	指向OH_AbilityRuntime_ModObjExtensionInstance实例的指针。
OH_AbilityRuntime_ModObjExtensionContextHandle* context	指向OH_AbilityRuntime_ModObjExtensionContextHandle的指针，用于接收ExtensionAbility上下文，作为输出参数。

返回：

展开

类型	说明
AbilityRuntime_ErrorCode	返回特定的错误码。 ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。 ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

类型

说明

AbilityRuntime_ErrorCode

返回特定的错误码。

ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。

ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

OH_AbilityRuntime_ModObjExtensionAbility_GetInstanceFromBase()

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

收起
自动换行
深色代码主题
复制
AbilityRuntime_ErrorCode OH_AbilityRuntime_ModObjExtensionAbility_GetInstanceFromBase(AbilityRuntime_ExtensionInstanceHandle baseExtensionInstance, OH_AbilityRuntime_ModObjExtensionInstanceHandle* modObjExtensionInstance)

描述

从基础ExtensionAbility实例中获取ModularObjectExtensionAbility实例。若传入的实例不是ModularObjectExtensionAbility类型，将返回ABILITY_RUNTIME_ERROR_CODE_INCORRECT_ABILITY_TYPE错误码。

起始版本： 26.0.0

参数：

展开

参数项	描述
AbilityRuntime_ExtensionInstanceHandle baseExtensionInstance	指向AbilityRuntime_ExtensionInstance的指针。
OH_AbilityRuntime_ModObjExtensionInstanceHandle* modObjExtensionInstance	指向OH_AbilityRuntime_ModObjExtensionInstance的指针，用于接收ModularObjectExtensionAbility实例，作为输出参数。

返回：

展开

类型	说明
AbilityRuntime_ErrorCode	返回特定的错误码。 ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。 ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。 ABILITY_RUNTIME_ERROR_CODE_INCORRECT_ABILITY_TYPE ExtensionAbility实例不是ModularObjectExtensionAbility类型，请确保传入的ExtensionAbility实例类型正确。

类型

说明

AbilityRuntime_ErrorCode

返回特定的错误码。

ABILITY_RUNTIME_ERROR_CODE_NO_ERROR 接口调用成功。

ABILITY_RUNTIME_ERROR_CODE_PARAM_INVALID 参数校验失败，请检查传入的参数是否有效。

ABILITY_RUNTIME_ERROR_CODE_INCORRECT_ABILITY_TYPE ExtensionAbility实例不是ModularObjectExtensionAbility类型，请确保传入的ExtensionAbility实例类型正确。