1# inputmethod_attach_options_capi.h 2<!--Kit: IME Kit--> 3<!--Subsystem: MiscServices--> 4<!--Owner: @illybyy--> 5<!--Designer: @andeszhang--> 6<!--Tester: @murphy1984--> 7<!--Adviser: @zhang_yixin13--> 8 9## 概述 10 11提供输入法绑定选项对象的创建、销毁与读写方法。 12 13**引用文件：** <inputmethod/inputmethod_attach_options_capi.h> 14 15**库：** libohinputmethod.so 16 17**系统能力：** SystemCapability.MiscServices.InputMethodFramework 18 19**起始版本：** 12 20 21**相关模块：** [InputMethod](capi-inputmethod.md) 22 23## 汇总 24 25### 结构体 26 27| 名称 | typedef关键字 | 描述 | 28| -- | -- | -- | 29| [InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md) | InputMethod_AttachOptions | 输入法绑定选项。绑定输入法时携带的选项。 | 30 31### 函数 32 33| 名称 | 描述 | 34| -- |------------------------------------------------| 35| [InputMethod_AttachOptions *OH_AttachOptions_Create(bool showKeyboard)](#oh_attachoptions_create) | 创建一个新的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 | 36| [InputMethod_AttachOptions *OH_AttachOptions_CreateWithRequestKeyboardReason(bool showKeyboard, InputMethod_RequestKeyboardReason requestKeyboardReason)](#oh_attachoptions_createwithrequestkeyboardreason) | 创建一个新的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 | 37| [void OH_AttachOptions_Destroy(InputMethod_AttachOptions *options)](#oh_attachoptions_destroy) | 销毁一个[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 | 38| [InputMethod_ErrorCode OH_AttachOptions_IsShowKeyboard(InputMethod_AttachOptions *options, bool *showKeyboard)](#oh_attachoptions_isshowkeyboard) | 从[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)中获取是否显示键盘的值。 | 39| [InputMethod_ErrorCode OH_AttachOptions_GetRequestKeyboardReason(InputMethod_AttachOptions *options, int *requestKeyboardReason)](#oh_attachoptions_getrequestkeyboardreason) | 从[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)中获取是否显示键盘的值。 | 40 41## 函数说明 42 43### OH_AttachOptions_Create() 44 45``` 46InputMethod_AttachOptions *OH_AttachOptions_Create(bool showKeyboard) 47``` 48 49**描述** 50 51创建一个新的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 52 53**起始版本：** 12 54 55 56**参数：** 57 58| 参数项 | 描述 | 59| -- | -- | 60| bool showKeyboard | 表示是否显示键盘。 | 61 62**返回：** 63 64| 类型 | 说明 | 65| -- | -- | 66| [InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md) * | 如果创建成功，返回一个指向新创建的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例的指针。<br> 如果创建失败，对象返回NULL，可能的失败原因有应用地址空间满。 | 67 68### OH_AttachOptions_CreateWithRequestKeyboardReason() 69 70``` 71InputMethod_AttachOptions *OH_AttachOptions_CreateWithRequestKeyboardReason(bool showKeyboard, InputMethod_RequestKeyboardReason requestKeyboardReason) 72``` 73 74**描述** 75 76创建一个新的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 77 78**起始版本：** 15 79 80 81**参数：** 82 83| 参数项 | 描述 | 84| -- | -- | 85| bool showKeyboard | 表示是否显示键盘。 | 86| [InputMethod_RequestKeyboardReason](capi-inputmethod-types-capi-h.md#inputmethod_requestkeyboardreason) requestKeyboardReason | 表示请求键盘输入原因。 | 87 88**返回：** 89 90| 类型 | 说明 | 91| -- | -- | 92| [InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md) * | 如果创建成功，返回一个指向新创建的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例的指针。<br> 如果创建失败，对象返回NULL，可能的失败原因有应用地址空间满。 | 93 94### OH_AttachOptions_Destroy() 95 96``` 97void OH_AttachOptions_Destroy(InputMethod_AttachOptions *options) 98``` 99 100**描述** 101 102销毁一个[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 103 104**起始版本：** 12 105 106 107**参数：** 108 109| 参数项 | 描述 | 110| -- | -- | 111| [InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md) *options | 表示即将被销毁的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 | 112 113### OH_AttachOptions_IsShowKeyboard() 114 115``` 116InputMethod_ErrorCode OH_AttachOptions_IsShowKeyboard(InputMethod_AttachOptions *options, bool *showKeyboard) 117``` 118 119**描述** 120 121从[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)中获取是否显示键盘的值。 122 123**起始版本：** 12 124 125 126**参数：** 127 128| 参数项 | 描述 | 129| -- | -- | 130| [InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md) *options | 表示被读取值的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 | 131| bool *showKeyboard | 表示绑定时是否显示键盘。true - 表示绑定完成时需要显示键盘。false - 表示绑定完成时不需要显示键盘。 | 132 133**返回：** 134 135| 类型 | 说明 | 136| -- | -- | 137| [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) | 返回一个特定的错误码。<br> [IME_ERR_OK](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 表示成功。<br> [IME_ERR_NULL_POINTER](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 非预期的空指针。<br> 具体错误码可以参考 [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode)。 | 138 139### OH_AttachOptions_GetRequestKeyboardReason() 140 141``` 142InputMethod_ErrorCode OH_AttachOptions_GetRequestKeyboardReason(InputMethod_AttachOptions *options, int *requestKeyboardReason) 143``` 144 145**描述** 146 147从[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)中获取是否显示键盘的值。 148 149**起始版本：** 15 150 151 152**参数：** 153 154| 参数项 | 描述 | 155| -- | -- | 156| [InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md) *options | 表示被读取值的[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例。 | 157| int *requestKeyboardReason | 表示一个指向[InputMethod_AttachOptions](capi-inputmethod-inputmethod-attachoptions.md)实例的指针。该参数用于表示请求键盘输入原因。 | 158 159**返回：** 160 161| 类型 | 说明 | 162| -- | -- | 163| [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) | 返回一个特定的错误码。<br> [IME_ERR_OK](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 表示成功。<br> [IME_ERR_NULL_POINTER](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 非预期的空指针。<br> 具体错误码可以参考 [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode)。 | 164 165 166