1# native_child_process.h 2 3<!--Kit: Ability Kit--> 4<!--Subsystem: Ability--> 5<!--Owner: @SKY2001--> 6<!--Designer: @jsjzju--> 7<!--Tester: @lixueqing513--> 8<!--Adviser: @huipeizi--> 9 10## 概述 11 12支持创建Native子进程,并在父子进程间建立IPC通道。 13 14通过此模块和[childProcessManager](js-apis-app-ability-childProcessManager.md)(非SELF_FORK模式)可以启动的子进程总数最大为512个。 15 16**引用文件:** <AbilityKit/native_child_process.h> 17 18**库:** libchild_process.so 19 20**系统能力:** SystemCapability.Ability.AbilityRuntime.Core 21 22**起始版本:** 12 23 24**相关模块:** [ChildProcess](capi-childprocess.md) 25 26## 汇总 27 28### 结构体 29 30| 名称 | typedef关键字 | 描述 | 31| -- | -- | -- | 32| [NativeChildProcess_Fd](capi-nativechildprocess-fd.md) | NativeChildProcess_Fd | 传递给子进程的文件描述符信息。 | 33| [NativeChildProcess_FdList](capi-nativechildprocess-fdlist.md) | NativeChildProcess_FdList | 传递给子进程的文件描述符信息列表。文件描述符记录个数不能超过16个。 | 34| [NativeChildProcess_Options](capi-nativechildprocess-options.md) | NativeChildProcess_Options | 子进程所使用的选项。 | 35| [NativeChildProcess_Args](capi-nativechildprocess-args.md) | NativeChildProcess_Args | 传递给子进程的参数。 | 36| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md) | Ability_ChildProcessConfigs | 启动子进程的配置信息,包括子进程的进程名、以及数据沙箱与网络环境的共享模式。 | 37 38### 枚举 39 40| 名称 | typedef关键字 | 描述 | 41| -- | -- | -- | 42| [Ability_NativeChildProcess_ErrCode](#ability_nativechildprocess_errcode) | Ability_NativeChildProcess_ErrCode | 定义Native子进程模块错误码。 | 43| [NativeChildProcess_IsolationMode](#nativechildprocess_isolationmode) | NativeChildProcess_IsolationMode | 定义Native子进程数据沙箱与网络环境的共享模式。 | 44 45### 函数 46 47| 名称 | typedef关键字 | 描述 | 48| -- | -- | -- | 49| [Ability_ChildProcessConfigs* OH_Ability_CreateChildProcessConfigs()](#oh_ability_createchildprocessconfigs) | - | 创建一个子进程配置信息对象。创建对象成功后需要通过调用[OH_Ability_DestroyChildProcessConfigs](capi-native-child-process-h.md#oh_ability_destroychildprocessconfigs)来销毁对象从而避免内存泄漏。 | 50| [Ability_NativeChildProcess_ErrCode OH_Ability_DestroyChildProcessConfigs(Ability_ChildProcessConfigs* configs)](#oh_ability_destroychildprocessconfigs) | - | 销毁一个子进程配置信息对象,并释放其内存,在调用该接口后,要避免继续使用已销毁的configs对象。 | 51| [Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetIsolationMode(Ability_ChildProcessConfigs* configs, NativeChildProcess_IsolationMode isolationMode)](#oh_ability_childprocessconfigs_setisolationmode) | - | 设置子进程配置信息对象的数据沙箱与网络环境的共享模式,详见[NativeChildProcess_IsolationMode](capi-native-child-process-h.md#nativechildprocess_isolationmode)。该设置仅当调用[OH_Ability_StartNativeChildProcessWithConfigs](capi-native-child-process-h.md#oh_ability_startnativechildprocesswithconfigs)接口时生效。 | 52| [Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetProcessName(Ability_ChildProcessConfigs* configs,const char* processName)](#oh_ability_childprocessconfigs_setprocessname) | - | 设置子进程配置信息对象中的进程名称。 | 53| [typedef void (\*OH_Ability_OnNativeChildProcessStarted)(int errCode, OHIPCRemoteProxy *remoteProxy)](#oh_ability_onnativechildprocessstarted) | OH_Ability_OnNativeChildProcessStarted | 根据传入的子进程配置信息创建子进程,并加载参数中指定的动态链接库文件。子进程的启动结果通过回调参数异步通知调用方。该回调在独立线程中执行,需要确保线程同步,且不能执行高耗时操作避免长时间阻塞。 | 54| [int OH_Ability_CreateNativeChildProcess(const char* libName,OH_Ability_OnNativeChildProcessStarted onProcessStarted)](#oh_ability_createnativechildprocess) | - | 创建子进程并加载参数中指定的动态链接库文件,进程启动结果通过回调参数异步通知,需注意回调通知为独立线程,回调函数实现需要注意线程同步,且不能执行高耗时操作避免长时间阻塞。参数所指定的动态库必须实现并导出下列函数:<br>1. OHIPCRemoteStub* NativeChildProcess_OnConnect()<br>2. void NativeChildProcess_MainProc()<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_CreateNativeChildProcess(libName, onProcessStartedCallback)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("NativeChildProcess_OnConnect")<br>4. dlsym("NativeChildProcess_MainProc")<br>5. ipcRemote = NativeChildProcess_OnConnect()<br>6. NativeChildProcess_MainProc()<br>主进程:<br>7. onProcessStartedCallback(ipcRemote, errCode)<br>子进程:<br>8. 在NativeChildProcess_MainProc()函数返回后子进程退出。<br>**设备行为差异:** 对于API 13及之前版本,该接口在PC/2in1中可正常使用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。对于API 14及之后版本,该接口在PC/2in1、Tablet设备可正常使用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。<br>**说明:** 对于API 14及之前版本,单个进程只能启动1个Native子进程。从API 15开始,单个进程最多支持启动50个Native子进程。 | 55| [Ability_NativeChildProcess_ErrCode OH_Ability_CreateNativeChildProcessWithConfigs(const char* libName,Ability_ChildProcessConfigs* configs, OH_Ability_OnNativeChildProcessStarted onProcessStarted)](#oh_ability_createnativechildprocesswithconfigs) | - | 根据传入的子进程配置信息创建子进程,并加载参数中指定的动态链接库文件。子进程的启动结果通过回调参数异步通知调用方。该回调在独立线程中执行,需要确保线程同步,且不能执行高耗时操作避免长时间阻塞。参数所指定的动态库必须实现并导出下列函数:<br>1. OHIPCRemoteStub* NativeChildProcess_OnConnect()<br>2. void NativeChildProcess_MainProc()<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_CreateNativeChildProcessWithConfigs(libName, configs, onProcessStartedCallback)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("NativeChildProcess_OnConnect")<br>4. dlsym("NativeChildProcess_MainProc")<br>5. ipcRemote = NativeChildProcess_OnConnect()<br>6. NativeChildProcess_MainProc()<br>主进程:<br>7. onProcessStartedCallback(ipcRemote, errCode)<br>子进程:<br>8. <br>在NativeChildProcess_MainProc()函数返回后子进程退出。<br>**设备行为差异:** 该接口在PC/2in1、Tablet设备中可正常调用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 | 56| [Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcess(const char* entry, NativeChildProcess_Args args,NativeChildProcess_Options options, int32_t *pid)](#oh_ability_startnativechildprocess) | - | 启动一个子进程,并加载指定的动态链接库文件。指定的动态库必须实现一个以NativeChildProcess_Args为参数的函数(函数名称可自定义),并导出该函数。示例如下:<br>1. void Main(NativeChildProcess_Args args);<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_StartNativeChildProcess(entryPoint, args, options)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("Main")<br>4. Main(args)<br>5. 子进程将在Main(args)函数返回后退出。<br>**设备行为差异:** 对于API 13及之前版本,该接口在PC/2in1设备中可正常使用,在其他设备类型中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。对于API 14及之后版本,该接口在PC/2in1、Tablet中可正常使用,在其他设备类型中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 | 57| [Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcessWithConfigs(const char* entry, NativeChildProcess_Args args, Ability_ChildProcessConfigs* configs, int32_t *pid)](#oh_ability_startnativechildprocesswithconfigs) | - | 根据参数中子进程配置信息启动Native子进程,加载参数中指定的动态链接库文件并调用入口函数。支持传参到子进程。指定的动态库必须实现一个以NativeChildProcess_Args为参数的函数(函数名称可自定义),并导出该函数。示例如下:<br>1. void Main(NativeChildProcess_Args args);<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_StartNativeChildProcessWithConfigs(entryPoint, args, configs, &pid)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("Main")<br>4. Main(args)<br>5. 子进程将在Main(args)函数返回后退出。<br>**设备行为差异:** 该接口在PC/2in1、Tablet设备中可正常调用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 | 58| [NativeChildProcess_Args* OH_Ability_GetCurrentChildProcessArgs()](#oh_ability_getcurrentchildprocessargs) | - | 子进程获取自身的启动参数。 | 59| [typedef void (\*OH_Ability_OnNativeChildProcessExit)(int32_t pid, int32_t signal)](#oh_ability_onnativechildprocessexit) | OH_Ability_OnNativeChildProcessExit | 获取子进程退出信息。 | 60| [Ability_NativeChildProcess_ErrCode OH_Ability_RegisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit)](#oh_ability_registernativechildprocessexitcallback) | - | 注册子进程退出回调。重复注册同一个回调函数只会保留一个。 | 61| [Ability_NativeChildProcess_ErrCode OH_Ability_UnregisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit)](#oh_ability_unregisternativechildprocessexitcallback) | - | 解注册子进程退出回调。 | 62 63## 枚举类型说明 64 65### Ability_NativeChildProcess_ErrCode 66 67``` 68enum Ability_NativeChildProcess_ErrCode 69``` 70 71**描述** 72 73定义Native子进程模块错误码。 74 75**起始版本:** 12 76 77| 枚举项 | 描述 | 78| -- | -- | 79| NCP_NO_ERROR = 0 | 操作成功。 | 80| NCP_ERR_INVALID_PARAM = 401 | 无效参数。 | 81| NCP_ERR_NOT_SUPPORTED = 801 | 不支持创建Native子进程。 | 82| NCP_ERR_INTERNAL = 16000050 | 内部错误。 | 83| NCP_ERR_BUSY = 16010001 | 在Native子进程的启动过程中不能再次创建新的子进程,可以等待当前子进程启动完成后再次尝试。从API version 15开始被废弃。 | 84| NCP_ERR_TIMEOUT = 16010002 | 启动Native子进程超时。 | 85| NCP_ERR_SERVICE_ERROR = 16010003 | 服务端出错。 | 86| NCP_ERR_MULTI_PROCESS_DISABLED = 16010004 | 多进程模式已关闭,不允许启动子进程。 | 87| NCP_ERR_ALREADY_IN_CHILD = 16010005 | 不允许在子进程中再次创建进程。 | 88| NCP_ERR_MAX_CHILD_PROCESSES_REACHED = 16010006 | 到达最大Native子进程数量限制,不能再创建子进程。 | 89| NCP_ERR_LIB_LOADING_FAILED = 16010007 | 子进程加载动态库失败,文件不存在或者未实现对应的方法并导出。 | 90| NCP_ERR_CONNECTION_FAILED = 16010008 | 子进程调用动态库的OnConnect方法失败,可能返回了无效的IPC对象指针。 | 91| NCP_ERR_CALLBACK_NOT_EXIST = 16010009 | 父进程调用解注册Native子进程退出回调,未找到注册的回调函数。 | 92 93### NativeChildProcess_IsolationMode 94 95``` 96enum NativeChildProcess_IsolationMode 97``` 98 99**描述** 100 101定义Native子进程数据沙箱与网络环境的共享模式。 102 103**起始版本:** 13 104 105| 枚举项 | 描述 | 106| -- | -- | 107| NCP_ISOLATION_MODE_NORMAL = 0 | 普通隔离模式下,父进程与子进程共享同一沙箱环境或网络环境。 | 108| NCP_ISOLATION_MODE_ISOLATED = 1 | 在隔离模式下,父进程与子进程不共享同一沙箱环境或网络环境。 | 109 110 111## 函数说明 112 113### OH_Ability_CreateChildProcessConfigs() 114 115``` 116Ability_ChildProcessConfigs* OH_Ability_CreateChildProcessConfigs() 117``` 118 119**描述** 120 121创建一个子进程配置信息对象。创建对象成功后需要通过调用[OH_Ability_DestroyChildProcessConfigs](capi-native-child-process-h.md#oh_ability_destroychildprocessconfigs)来销毁对象从而避免内存泄漏。 122 123**起始版本:** 20 124 125**返回:** 126 127| 类型 | 说明 | 128|----------------------------------| -- | 129| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)* | 返回一个指向[Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)对象的指针 - 子进程配置信息对象创建成功。<br> 返回nullptr - 发生内部错误或者内存分配失败。 | 130 131### OH_Ability_DestroyChildProcessConfigs() 132 133``` 134Ability_NativeChildProcess_ErrCode OH_Ability_DestroyChildProcessConfigs(Ability_ChildProcessConfigs* configs) 135``` 136 137**描述** 138 139销毁一个子进程配置信息对象,并释放其内存,在调用该接口后,要避免继续使用已销毁的configs对象。 140 141**起始版本:** 20 142 143 144**参数:** 145 146| 参数项 | 描述 | 147| -- | -- | 148| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)* configs | 需要销毁的子进程配置信息对象指针。在调用该接口后,对象指针将失效,避免继续使用该指针。允许传入空指针,空指针不会触发任何操作。 | 149 150**返回:** 151 152| 类型 | 说明 | 153| -- | -- | 154| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 操作成功。<br>NCP_NO_ERR_INVALID_PARAM - 传入参数为nullptr。 | 155 156### OH_Ability_ChildProcessConfigs_SetIsolationMode() 157 158``` 159Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetIsolationMode(Ability_ChildProcessConfigs* configs, NativeChildProcess_IsolationMode isolationMode) 160``` 161 162**描述** 163 164设置子进程配置信息对象的数据沙箱与网络环境的共享模式,详见[NativeChildProcess_IsolationMode](capi-native-child-process-h.md#nativechildprocess_isolationmode)。该设置仅当调用[OH_Ability_StartNativeChildProcessWithConfigs](capi-native-child-process-h.md#oh_ability_startnativechildprocesswithconfigs)接口时生效。 165 166**起始版本:** 20 167 168 169**参数:** 170 171| 参数项 | 描述 | 172| -- | -- | 173| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)* configs | 子进程的配置信息对象指针。不可以为空指针。 | 174| [NativeChildProcess_IsolationMode](capi-native-child-process-h.md#nativechildprocess_isolationmode) isolationMode | 要设置的数据沙箱与网络环境的共享模式,详见NativeChildProcess_IsolationMode。 | 175 176**返回:** 177 178| 类型 | 说明 | 179| -- | -- | 180| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 执行成功。<br>NCP_NO_ERR_INVALID_PARAM - 传入参数configs为nullptr。 | 181 182### OH_Ability_ChildProcessConfigs_SetProcessName() 183 184``` 185Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetProcessName(Ability_ChildProcessConfigs* configs,const char* processName) 186``` 187 188**描述** 189 190设置子进程配置信息对象中的进程名称。 191 192**起始版本:** 20 193 194 195**参数:** 196 197| 参数项 | 描述 | 198| -- | -- | 199| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)* configs | 子进程的配置信息对象指针。不能为空指针。 | 200| const char* processName | 设置的子进程名字符串必须是非空字符串,并且只能由字母、数字和下划线构成。最大长度为64字符。最终的进程名是{bundleName}:{processName}。 | 201 202**返回:** 203 204| 类型 | 说明 | 205| -- | -- | 206| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 执行成功。<br>NCP_NO_ERR_INVALID_PARAM - 传入参数configs为nullptr,或者processName包含除字母、数字、下划线以外的字符。 | 207 208### OH_Ability_OnNativeChildProcessStarted() 209 210``` 211typedef void (*OH_Ability_OnNativeChildProcessStarted)(int errCode, OHIPCRemoteProxy *remoteProxy) 212``` 213 214**描述** 215 216定义通知子进程启动结果的回调函数。 217 218**起始版本:** 12 219 220**参数:** 221 222| 参数项 | 描述 | 223| -- | -- | 224| int errCode | 回调函数返回的错误码,可用的值如下:<br>[NCP_NO_ERROR](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 创建子进程成功。<br>[NCP_ERR_LIB_LOADING_FAILED](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 加载动态库文件失败或动态库中未实现必要的导出函数。<br>[NCP_ERR_CONNECTION_FAILED](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 动态库中实现的OnConnect方法未返回有效的IPC Stub指针。<br>详见[Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode)定义。 | 225| [OHIPCRemoteProxy *remoteProxy](../apis-ipc-kit/capi-ohipcparcel-ohipcremoteproxy.md) | 子进程的IPC对象指针,出现异常时可能为nullptr:使用完毕后需要调用[OH_IPCRemoteProxy_Destory](../apis-ipc-kit/capi-ipc-cremote-object-h.md#oh_ipcremoteproxy_destroy)方法释放。 | 226 227**参考:** 228 229[OH_IPCRemoteProxy_Destory](../apis-ipc-kit/capi-ipc-cremote-object-h.md#oh_ipcremoteproxy_destroy) 230 231### OH_Ability_CreateNativeChildProcess() 232 233``` 234int OH_Ability_CreateNativeChildProcess(const char* libName,OH_Ability_OnNativeChildProcessStarted onProcessStarted) 235``` 236 237**描述** 238 239创建子进程并加载参数中指定的动态链接库文件,进程启动结果通过回调参数异步通知,需注意回调通知为独立线程,回调函数实现需要注意线程同步,且不能执行高耗时操作避免长时间阻塞。 240 241参数所指定的动态库必须实现并导出下列函数:<br>1. OHIPCRemoteStub* NativeChildProcess_OnConnect()<br>2. void NativeChildProcess_MainProc()<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_CreateNativeChildProcess(libName, onProcessStartedCallback)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("NativeChildProcess_OnConnect")<br>4. dlsym("NativeChildProcess_MainProc")<br>5. ipcRemote = NativeChildProcess_OnConnect()<br>6. NativeChildProcess_MainProc()<br>主进程:<br>7. onProcessStartedCallback(ipcRemote, errCode)<br>子进程:<br>8. 在NativeChildProcess_MainProc()函数返回后子进程退出。 242 243**设备行为差异:** 对于API version 13及之前版本,该接口在PC/2in1中可正常使用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。对于API version 14及之后版本,该接口在PC/2in1、Tablet设备可正常使用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 244 245> **说明:** 246> 247> API version 14及之前版本,单个进程只能启动1个Native子进程。从API version 15开始,单个进程最多支持启动50个Native子进程。 248 249**起始版本:** 12 250 251**参数:** 252 253| 参数项 | 描述 | 254| -- | -- | 255| const char* libName | 子进程中加载的动态库文件名称,不能为nullptr。 | 256| [OH_Ability_OnNativeChildProcessStarted](capi-native-child-process-h.md#oh_ability_onnativechildprocessstarted) onProcessStarted | 通知子进程启动结果的回调函数指针,不能为nullptr。详见[OH_Ability_OnNativeChildProcessStarted](capi-native-child-process-h.md#oh_ability_onnativechildprocessstarted)。 | 257 258**返回:** 259 260| 类型 | 说明 | 261| -- | -- | 262| int | [NCP_NO_ERROR](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 调用成功,但子进程的实际启动结果由回调函数通知。<br>[NCP_ERR_INVALID_PARAM](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 无效的动态库名称或者回调函数指针。<br>[NCP_ERR_NOT_SUPPORTED](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 当前设备不支持创建Native子进程。<br>[NCP_ERR_MULTI_PROCESS_DISABLED](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 当前设备已关闭多进程模式。<br>[NCP_ERR_ALREADY_IN_CHILD](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 不允许在子进程中再次创建子进程。<br>[NCP_ERR_MAX_CHILD_PROCESSES_REACHED](capi-native-child-process-h.md#ability_nativechildprocess_errcode) - 到达最大Native子进程数限制。<br>详见[Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode)定义。 | 263 264**参考:** 265 266[OH_Ability_OnNativeChildProcessStarted](capi-native-child-process-h.md#oh_ability_onnativechildprocessstarted) 267 268### OH_Ability_CreateNativeChildProcessWithConfigs() 269 270``` 271Ability_NativeChildProcess_ErrCode OH_Ability_CreateNativeChildProcessWithConfigs(const char* libName,Ability_ChildProcessConfigs* configs, OH_Ability_OnNativeChildProcessStarted onProcessStarted) 272``` 273 274**描述** 275 276根据传入的子进程配置信息创建子进程,并加载参数中指定的动态链接库文件。子进程的启动结果通过回调参数异步通知调用方。该回调在独立线程中执行,需要确保线程同步,且不能执行高耗时操作避免长时间阻塞。 277 278参数所指定的动态库必须实现并导出下列函数:<br>1. OHIPCRemoteStub* NativeChildProcess_OnConnect()<br>2. void NativeChildProcess_MainProc()<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_CreateNativeChildProcessWithConfigs(libName, configs, onProcessStartedCallback)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("NativeChildProcess_OnConnect")<br>4. dlsym("NativeChildProcess_MainProc")<br>5. ipcRemote = NativeChildProcess_OnConnect()<br>6. NativeChildProcess_MainProc()<br>主进程:<br>7. onProcessStartedCallback(ipcRemote, errCode)<br>子进程:<br>8. 在NativeChildProcess_MainProc()函数返回后子进程退出。 279 280**设备行为差异:** 该接口在PC/2in1、Tablet设备中可正常调用,在其他设备中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 281 282**起始版本:** 20 283 284**参数:** 285 286| 参数项 | 描述 | 287| -- | -- | 288| const char* libName | 子进程中加载的动态库文件名称,不能为nullptr。 | 289| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)* configs | 子进程的配置信息参数,不能为nullptr。 | 290| [OH_Ability_OnNativeChildProcessStarted](capi-native-child-process-h.md#oh_ability_onnativechildprocessstarted) onProcessStarted | 通知子进程启动结果的回调函数指针,不能为nullptr,详见OH_Ability_OnNativeChildProcessStarted。 | 291 292**返回:** 293 294| 类型 | 说明 | 295| -- | -- | 296| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 执行成功。<br>NCP_ERR_INVALID_PARAM - 传入参数无效。<br>NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。<br>NCP_ERR_MULTI_PROCESS_DISABLED - 当前设备已关闭多进程模式,不允许启动子进程。<br>NCP_ERR_ALREADY_IN_CHILD - 不允许在子进程中再次创建子进程。<br>NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 超过最大Native子进程数限制。<br>详见Ability_NativeChildProcess_ErrCode定义。 | 297 298**参考:** 299 300[OH_Ability_OnNativeChildProcessStarted](capi-native-child-process-h.md#oh_ability_onnativechildprocessstarted) 301 302### OH_Ability_StartNativeChildProcess() 303 304``` 305Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcess(const char* entry, NativeChildProcess_Args args,NativeChildProcess_Options options, int32_t *pid) 306``` 307 308**描述** 309 310启动Native子进程,并加载参数中指定的动态链接库文件并调用入口函数。指定的动态库必须实现一个以[NativeChildProcess_Args](capi-nativechildprocess-args.md)为参数的函数(函数名称可自定义),并导出该函数。支持传参到子进程。子进程中不支持创建ArkTS基础运行时环境。 311 312示例如下:<br>void Main(NativeChildProcess_Args args);<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_StartNativeChildProcess(entryPoint, args, options)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("Main")<br>4. Main(args)<br>5. 子进程将在Main(args)函数返回后退出。 313 314**设备行为差异:** 对于API 13及之前版本,该接口在PC/2in1设备中可正常使用,在其他设备类型中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。对于API 14及之后版本,该接口在PC/2in1、Tablet中可正常使用,在其他设备类型中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 315 316**起始版本:** 13 317 318**参数:** 319 320| 参数项 | 描述 | 321| -- | -- | 322| const char* entry | 子进程中加载的动态库及入口函数,例如"libEntry.so:Main",不能为nullptr。 | 323| [NativeChildProcess_Args](capi-nativechildprocess-args.md) args | 传递给子进程的参数。 | 324| [NativeChildProcess_Options](capi-nativechildprocess-options.md) options | 子进程选项。 | 325| int32_t *pid | 启动的子进程id。 | 326 327**返回:** 328 329| 类型 | 说明 | 330| -- | -- | 331| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 调用成功。<br>NCP_ERR_INVALID_PARAM - 无效的动态库名称或者回调函数指针。<br>NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。<br> NCP_ERR_ALREADY_IN_CHILD - 当前设备已关闭多进程模式。<br>NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 到达最大Native子进程数限制。<br>详见Ability_NativeChildProcess_ErrCode定义。 | 332 333**参考:** 334 335[OH_Ability_OnNativeChildProcessStarted](capi-native-child-process-h.md#oh_ability_onnativechildprocessstarted) 336 337### OH_Ability_StartNativeChildProcessWithConfigs() 338 339``` 340Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcessWithConfigs(const char* entry, NativeChildProcess_Args args, Ability_ChildProcessConfigs* configs, int32_t *pid) 341``` 342 343**描述** 344 345根据参数中子进程配置信息启动Native子进程,加载参数中指定的动态链接库文件并调用入口函数。支持传参到子进程。指定的动态库必须实现一个以[NativeChildProcess_Args](capi-nativechildprocess-args.md)为参数的函数(函数名称可自定义),并导出该函数。 346 347示例如下:<br>void Main(NativeChildProcess_Args args);<br>处理逻辑顺序如下列伪代码所示:<br>主进程:<br>1. OH_Ability_StartNativeChildProcessWithConfigs(entryPoint, args, configs, &pid)<br>子进程:<br>2. dlopen(libName)<br>3. dlsym("Main")<br>4. Main(args)<br>5. 子进程将在Main(args)函数返回后退出。 348 349**设备行为差异:** 该接口在PC/2in1、Tablet中可正常调用,在其他设备类型中返回[NCP_ERR_NOT_SUPPORTED](#ability_nativechildprocess_errcode)错误码。 350 351**起始版本:** 20 352 353**参数:** 354 355| 参数项 | 描述 | 356| -- | -- | 357| const char* entry | 子进程中调用动态库的符号和入口函数,中间用“:”隔开(例如“libentry.so:Main”),不能为nullptr。 | 358| [NativeChildProcess_Args](capi-nativechildprocess-args.md) args | 传给子进程的参数。 | 359| [Ability_ChildProcessConfigs](capi-ability-childprocessconfigs.md)* configs | 子进程的配置信息参数。 | 360| int32_t *pid | 被启动的子进程号。 | 361 362**返回:** 363 364| 类型 | 说明 | 365| -- | -- | 366| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 执行成功。<br>NCP_ERR_INVALID_PARAM - 传入参数无效。<br>NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。<br>NCP_ERR_ALREADY_IN_CHILD - 不允许在子进程中再次创建子进程。<br>NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 超过最大Native子进程数限制。<br>详见Ability_NativeChildProcess_ErrCode定义。 | 367 368### OH_Ability_GetCurrentChildProcessArgs() 369 370``` 371NativeChildProcess_Args* OH_Ability_GetCurrentChildProcessArgs() 372``` 373 374**描述** 375 376通过[OH_Ability_StartNativeChildProcess](#oh_ability_startnativechildprocess)启动子进程后,子进程能够在任意so和任意子线程中获取启动参数[NativeChildProcess_Args](capi-nativechildprocess-args.md)。 377 378**起始版本:** 17 379 380**返回:** 381 382| 类型 | 说明 | 383|------------------------------| -- | 384| [NativeChildProcess_Args](capi-nativechildprocess-args.md)* | 返回指向当前子进程启动参数的指针。 | 385 386### OH_Ability_OnNativeChildProcessExit() 387 388``` 389typedef void (*OH_Ability_OnNativeChildProcessExit)(int32_t pid, int32_t signal) 390``` 391 392**描述** 393 394感知Native子进程退出的回调函数。 395 396**起始版本:** 20 397 398**参数:** 399 400| 参数项 | 描述 | 401| -- | -- | 402| int32_t pid | 启动的子进程id。 | 403| int32_t signal | 子进程退出信号。 | 404 405**参见:** 406 407[OH_Ability_RegisterNativeChildProcessExitCallback](#oh_ability_registernativechildprocessexitcallback) 408 409[OH_Ability_UnregisterNativeChildProcessExitCallback](#oh_ability_unregisternativechildprocessexitcallback) 410 411### OH_Ability_RegisterNativeChildProcessExitCallback() 412 413``` 414Ability_NativeChildProcess_ErrCode OH_Ability_RegisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit) 415``` 416 417**描述** 418 419注册Native子进程异常退出回调函数,当通过[OH_Ability_StartNativeChildProcess](#oh_ability_startnativechildprocess)和[@ohos.app.ability.childProcessManager的startNativeChildProcess](js-apis-app-ability-childProcessManager.md#childprocessmanagerstartnativechildprocess13)启动的子进程异常退出时,调用入口参数的回调函数。当重复注册同一个回调函数时,子进程退出时只会执行一次回调函数。 420 421参数必须实现[OH_Ability_OnNativeChildProcessExit](#oh_ability_onnativechildprocessexit)入口函数。详见[注册Native子进程退出回调](../../application-models/capi-nativechildprocess-exit-info.md)。 422 423**起始版本:** 20 424 425**参数:** 426 427| 参数项 | 描述 | 428| -- | -- | 429| [OH_Ability_OnNativeChildProcessExit](capi-native-child-process-h.md#oh_ability_onnativechildprocessexit) onProcessExit | 子进程退出的回调函数入口,不能为nullptr。 | 430 431**返回:** 432 433| 类型 | 说明 | 434| -- | -- | 435| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 调用成功。<br>NCP_ERR_INVALID_PARAM - 参数不合法。<br>NCP_ERR_INTERNAL - 内部错误。<br>详见Ability_NativeChildProcess_ErrCode。 | 436 437### OH_Ability_UnregisterNativeChildProcessExitCallback() 438 439``` 440Ability_NativeChildProcess_ErrCode OH_Ability_UnregisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit) 441``` 442 443**描述** 444 445解注册子进程退出回调。 446 447参数必须实现[OH_Ability_OnNativeChildProcessExit](#oh_ability_onnativechildprocessexit)入口函数。详见[解注册Native子进程退出回调](../../application-models/capi-nativechildprocess-exit-info.md)。 448 449**起始版本:** 20 450 451 452**参数:** 453 454| 参数项 | 描述 | 455| -- | -- | 456| [OH_Ability_OnNativeChildProcessExit](capi-native-child-process-h.md#oh_ability_onnativechildprocessexit) onProcessExit | 子进程退出的回调函数入口,不能为nullptr。 | 457 458**返回:** 459 460| 类型 | 说明 | 461| -- | -- | 462| [Ability_NativeChildProcess_ErrCode](capi-native-child-process-h.md#ability_nativechildprocess_errcode) | NCP_NO_ERROR - 调用成功。<br>NCP_ERR_INVALID_PARAM - 参数不合法。<br>NCP_ERR_INTERNAL - 内部错误。<br>NCP_ERR_CALLBACK_NOT_EXIST - 未找到回调函数。<br>详见Ability_NativeChildProcess_ErrCode。 | 463