1 /********************************************************** 2 * This file has been automatically created by "typemaker2" 3 * from the file "tanmethod.xml". 4 * Please do not edit this file, all changes will be lost. 5 * Better edit the mentioned source file instead. 6 **********************************************************/ 7 8 #ifndef AQFINTS_TANMETHOD_TANMETHOD_H 9 #define AQFINTS_TANMETHOD_TANMETHOD_H 10 11 12 #ifdef __cplusplus 13 extern "C" { 14 #endif 15 16 /** @page P_AQFINTS_TANMETHOD Structure AQFINTS_TANMETHOD 17 <p>This page describes the properties of AQFINTS_TANMETHOD.</p> 18 19 20 21 <h1>AQFINTS_TANMETHOD</h1> 22 23 24 25 @anchor AQFINTS_TANMETHOD_flags 26 <h2>flags</h2> 27 28 <p>Set this property with @ref AQFINTS_TanMethod_SetFlags(), get it with @ref AQFINTS_TanMethod_GetFlags().</p> 29 30 31 @anchor AQFINTS_TANMETHOD_function 32 <h2>function</h2> 33 34 <p>Set this property with @ref AQFINTS_TanMethod_SetFunction(), get it with @ref AQFINTS_TanMethod_GetFunction().</p> 35 36 37 @anchor AQFINTS_TANMETHOD_process 38 <h2>process</h2> 39 40 <p>Set this property with @ref AQFINTS_TanMethod_SetProcess(), get it with @ref AQFINTS_TanMethod_GetProcess().</p> 41 42 43 @anchor AQFINTS_TANMETHOD_methodId 44 <h2>methodId</h2> 45 46 <p>Set this property with @ref AQFINTS_TanMethod_SetMethodId(), get it with @ref AQFINTS_TanMethod_GetMethodId().</p> 47 48 49 @anchor AQFINTS_TANMETHOD_zkaTanName 50 <h2>zkaTanName</h2> 51 52 <p>Set this property with @ref AQFINTS_TanMethod_SetZkaTanName(), get it with @ref AQFINTS_TanMethod_GetZkaTanName().</p> 53 54 55 @anchor AQFINTS_TANMETHOD_zkaTanVersion 56 <h2>zkaTanVersion</h2> 57 58 <p>Set this property with @ref AQFINTS_TanMethod_SetZkaTanVersion(), get it with @ref AQFINTS_TanMethod_GetZkaTanVersion().</p> 59 60 61 @anchor AQFINTS_TANMETHOD_methodName 62 <h2>methodName</h2> 63 64 <p>Set this property with @ref AQFINTS_TanMethod_SetMethodName(), get it with @ref AQFINTS_TanMethod_GetMethodName().</p> 65 66 67 @anchor AQFINTS_TANMETHOD_tanMaxLen 68 <h2>tanMaxLen</h2> 69 70 <p>Set this property with @ref AQFINTS_TanMethod_SetTanMaxLen(), get it with @ref AQFINTS_TanMethod_GetTanMaxLen().</p> 71 72 73 @anchor AQFINTS_TANMETHOD_formatId 74 <h2>formatId</h2> 75 76 1: numeric, 2: alphanumeric 77 <p>Set this property with @ref AQFINTS_TanMethod_SetFormatId(), get it with @ref AQFINTS_TanMethod_GetFormatId().</p> 78 79 80 @anchor AQFINTS_TANMETHOD_prompt 81 <h2>prompt</h2> 82 83 <p>Set this property with @ref AQFINTS_TanMethod_SetPrompt(), get it with @ref AQFINTS_TanMethod_GetPrompt().</p> 84 85 86 @anchor AQFINTS_TANMETHOD_returnMaxLen 87 <h2>returnMaxLen</h2> 88 89 <p>Set this property with @ref AQFINTS_TanMethod_SetReturnMaxLen(), get it with @ref AQFINTS_TanMethod_GetReturnMaxLen().</p> 90 91 92 @anchor AQFINTS_TANMETHOD_maxActiveLists 93 <h2>maxActiveLists</h2> 94 95 <p>Set this property with @ref AQFINTS_TanMethod_SetMaxActiveLists(), get it with @ref AQFINTS_TanMethod_GetMaxActiveLists().</p> 96 97 98 @anchor AQFINTS_TANMETHOD_timeShiftAllowed 99 <h2>timeShiftAllowed</h2> 100 101 1: not allowed, 2: allowed, 3: both supported 102 <p>Set this property with @ref AQFINTS_TanMethod_SetTimeShiftAllowed(), get it with @ref AQFINTS_TanMethod_GetTimeShiftAllowed().</p> 103 104 105 @anchor AQFINTS_TANMETHOD_tanListMode 106 <h2>tanListMode</h2> 107 108 <p>Set this property with @ref AQFINTS_TanMethod_SetTanListMode(), get it with @ref AQFINTS_TanMethod_GetTanListMode().</p> 109 110 111 @anchor AQFINTS_TANMETHOD_needSmsAccount 112 <h2>needSmsAccount</h2> 113 114 0: must not be given, 1: may be given, 2: must be given 115 <p>Set this property with @ref AQFINTS_TanMethod_SetNeedSmsAccount(), get it with @ref AQFINTS_TanMethod_GetNeedSmsAccount().</p> 116 117 118 @anchor AQFINTS_TANMETHOD_needLocalAccount 119 <h2>needLocalAccount</h2> 120 121 0: must not be given, 2: must be given 122 <p>Set this property with @ref AQFINTS_TanMethod_SetNeedLocalAccount(), get it with @ref AQFINTS_TanMethod_GetNeedLocalAccount().</p> 123 124 125 @anchor AQFINTS_TANMETHOD_initMode 126 <h2>initMode</h2> 127 128 00: PIN without TAN, 01: HHD template 01, 02: reserved 129 <p>Set this property with @ref AQFINTS_TanMethod_SetInitMode(), get it with @ref AQFINTS_TanMethod_GetInitMode().</p> 130 131 132 @anchor AQFINTS_TANMETHOD_needTanMediumId 133 <h2>needTanMediumId</h2> 134 135 0: must not be given, 1: may be given, 2: must be given 136 <p>Set this property with @ref AQFINTS_TanMethod_SetNeedTanMediumId(), get it with @ref AQFINTS_TanMethod_GetNeedTanMediumId().</p> 137 138 139 @anchor AQFINTS_TANMETHOD_maxActiveTanMedia 140 <h2>maxActiveTanMedia</h2> 141 142 <p>Set this property with @ref AQFINTS_TanMethod_SetMaxActiveTanMedia(), get it with @ref AQFINTS_TanMethod_GetMaxActiveTanMedia().</p> 143 144 145 @anchor AQFINTS_TANMETHOD_runtimeFlags 146 <h2>runtimeFlags</h2> 147 148 <p>Set this property with @ref AQFINTS_TanMethod_SetRuntimeFlags(), get it with @ref AQFINTS_TanMethod_GetRuntimeFlags().</p> 149 150 */ 151 152 /* define AQFINTS_TANMETHOD_RTFLAGS */ 153 154 155 /* define AQFINTS_TANMETHOD_FLAGS */ 156 #define AQFINTS_TANMETHOD_FLAGS_MULTITAN_ALLOWED 0x00000001 157 #define AQFINTS_TANMETHOD_FLAGS_STORNO_ALLOWED 0x00000002 158 #define AQFINTS_TANMETHOD_FLAGS_NEED_CHALLENGE_CLASS 0x00000004 159 #define AQFINTS_TANMETHOD_FLAGS_CHALLENGE_IS_STRUCTURED 0x00000008 160 #define AQFINTS_TANMETHOD_FLAGS_NEED_HHDUC 0x00000010 161 162 163 /* needed system headers */ 164 #include <gwenhywfar/types.h> 165 #include <gwenhywfar/list1.h> 166 #include <gwenhywfar/db.h> 167 168 /* pre-headers */ 169 #include <libaqfints/aqfints.h> 170 171 typedef struct AQFINTS_TANMETHOD AQFINTS_TANMETHOD; 172 GWEN_LIST_FUNCTION_DEFS(AQFINTS_TANMETHOD, AQFINTS_TanMethod) 173 174 175 176 /* post-headers */ 177 178 179 /** Constructor. */ 180 AQFINTS_TANMETHOD *AQFINTS_TanMethod_new(void); 181 182 /** Destructor. */ 183 void AQFINTS_TanMethod_free(AQFINTS_TANMETHOD *p_struct); 184 185 void AQFINTS_TanMethod_Attach(AQFINTS_TANMETHOD *p_struct); 186 187 AQFINTS_TANMETHOD *AQFINTS_TanMethod_dup(const AQFINTS_TANMETHOD *p_struct); 188 189 AQFINTS_TANMETHOD *AQFINTS_TanMethod_copy(AQFINTS_TANMETHOD *p_struct, const AQFINTS_TANMETHOD *p_src); 190 191 /** Getter. 192 * Use this function to get the member "flags" (see @ref AQFINTS_TANMETHOD_flags) 193 */ 194 uint32_t AQFINTS_TanMethod_GetFlags(const AQFINTS_TANMETHOD *p_struct); 195 196 /** Getter. 197 * Use this function to get the member "function" (see @ref AQFINTS_TANMETHOD_function) 198 */ 199 int AQFINTS_TanMethod_GetFunction(const AQFINTS_TANMETHOD *p_struct); 200 201 /** Getter. 202 * Use this function to get the member "process" (see @ref AQFINTS_TANMETHOD_process) 203 */ 204 int AQFINTS_TanMethod_GetProcess(const AQFINTS_TANMETHOD *p_struct); 205 206 /** Getter. 207 * Use this function to get the member "methodId" (see @ref AQFINTS_TANMETHOD_methodId) 208 */ 209 const char *AQFINTS_TanMethod_GetMethodId(const AQFINTS_TANMETHOD *p_struct); 210 211 /** Getter. 212 * Use this function to get the member "zkaTanName" (see @ref AQFINTS_TANMETHOD_zkaTanName) 213 */ 214 const char *AQFINTS_TanMethod_GetZkaTanName(const AQFINTS_TANMETHOD *p_struct); 215 216 /** Getter. 217 * Use this function to get the member "zkaTanVersion" (see @ref AQFINTS_TANMETHOD_zkaTanVersion) 218 */ 219 const char *AQFINTS_TanMethod_GetZkaTanVersion(const AQFINTS_TANMETHOD *p_struct); 220 221 /** Getter. 222 * Use this function to get the member "methodName" (see @ref AQFINTS_TANMETHOD_methodName) 223 */ 224 const char *AQFINTS_TanMethod_GetMethodName(const AQFINTS_TANMETHOD *p_struct); 225 226 /** Getter. 227 * Use this function to get the member "tanMaxLen" (see @ref AQFINTS_TANMETHOD_tanMaxLen) 228 */ 229 int AQFINTS_TanMethod_GetTanMaxLen(const AQFINTS_TANMETHOD *p_struct); 230 231 /** Getter. 232 * Use this function to get the member "formatId" (see @ref AQFINTS_TANMETHOD_formatId) 233 */ 234 int AQFINTS_TanMethod_GetFormatId(const AQFINTS_TANMETHOD *p_struct); 235 236 /** Getter. 237 * Use this function to get the member "prompt" (see @ref AQFINTS_TANMETHOD_prompt) 238 */ 239 const char *AQFINTS_TanMethod_GetPrompt(const AQFINTS_TANMETHOD *p_struct); 240 241 /** Getter. 242 * Use this function to get the member "returnMaxLen" (see @ref AQFINTS_TANMETHOD_returnMaxLen) 243 */ 244 int AQFINTS_TanMethod_GetReturnMaxLen(const AQFINTS_TANMETHOD *p_struct); 245 246 /** Getter. 247 * Use this function to get the member "maxActiveLists" (see @ref AQFINTS_TANMETHOD_maxActiveLists) 248 */ 249 int AQFINTS_TanMethod_GetMaxActiveLists(const AQFINTS_TANMETHOD *p_struct); 250 251 /** Getter. 252 * Use this function to get the member "timeShiftAllowed" (see @ref AQFINTS_TANMETHOD_timeShiftAllowed) 253 */ 254 int AQFINTS_TanMethod_GetTimeShiftAllowed(const AQFINTS_TANMETHOD *p_struct); 255 256 /** Getter. 257 * Use this function to get the member "tanListMode" (see @ref AQFINTS_TANMETHOD_tanListMode) 258 */ 259 int AQFINTS_TanMethod_GetTanListMode(const AQFINTS_TANMETHOD *p_struct); 260 261 /** Getter. 262 * Use this function to get the member "needSmsAccount" (see @ref AQFINTS_TANMETHOD_needSmsAccount) 263 */ 264 int AQFINTS_TanMethod_GetNeedSmsAccount(const AQFINTS_TANMETHOD *p_struct); 265 266 /** Getter. 267 * Use this function to get the member "needLocalAccount" (see @ref AQFINTS_TANMETHOD_needLocalAccount) 268 */ 269 int AQFINTS_TanMethod_GetNeedLocalAccount(const AQFINTS_TANMETHOD *p_struct); 270 271 /** Getter. 272 * Use this function to get the member "initMode" (see @ref AQFINTS_TANMETHOD_initMode) 273 */ 274 const char *AQFINTS_TanMethod_GetInitMode(const AQFINTS_TANMETHOD *p_struct); 275 276 /** Getter. 277 * Use this function to get the member "needTanMediumId" (see @ref AQFINTS_TANMETHOD_needTanMediumId) 278 */ 279 int AQFINTS_TanMethod_GetNeedTanMediumId(const AQFINTS_TANMETHOD *p_struct); 280 281 /** Getter. 282 * Use this function to get the member "maxActiveTanMedia" (see @ref AQFINTS_TANMETHOD_maxActiveTanMedia) 283 */ 284 int AQFINTS_TanMethod_GetMaxActiveTanMedia(const AQFINTS_TANMETHOD *p_struct); 285 286 /** Getter. 287 * Use this function to get the member "runtimeFlags" (see @ref AQFINTS_TANMETHOD_runtimeFlags) 288 */ 289 uint32_t AQFINTS_TanMethod_GetRuntimeFlags(const AQFINTS_TANMETHOD *p_struct); 290 291 /** Setter. 292 * Use this function to set the member "flags" (see @ref AQFINTS_TANMETHOD_flags) 293 */ 294 void AQFINTS_TanMethod_SetFlags(AQFINTS_TANMETHOD *p_struct, uint32_t p_src); 295 296 /** Add flags. 297 * Use this function to add flags to the member "flags" 298 */ 299 void AQFINTS_TanMethod_AddFlags(AQFINTS_TANMETHOD *p_struct, uint32_t p_src); 300 301 /** Sub flags. 302 * Use this function to sub flags from the member "flags" 303 */ 304 void AQFINTS_TanMethod_SubFlags(AQFINTS_TANMETHOD *p_struct, uint32_t p_src); 305 306 /** Setter. 307 * Use this function to set the member "function" (see @ref AQFINTS_TANMETHOD_function) 308 */ 309 void AQFINTS_TanMethod_SetFunction(AQFINTS_TANMETHOD *p_struct, int p_src); 310 311 /** Setter. 312 * Use this function to set the member "process" (see @ref AQFINTS_TANMETHOD_process) 313 */ 314 void AQFINTS_TanMethod_SetProcess(AQFINTS_TANMETHOD *p_struct, int p_src); 315 316 /** Setter. 317 * Use this function to set the member "methodId" (see @ref AQFINTS_TANMETHOD_methodId) 318 */ 319 void AQFINTS_TanMethod_SetMethodId(AQFINTS_TANMETHOD *p_struct, const char *p_src); 320 321 /** Setter. 322 * Use this function to set the member "zkaTanName" (see @ref AQFINTS_TANMETHOD_zkaTanName) 323 */ 324 void AQFINTS_TanMethod_SetZkaTanName(AQFINTS_TANMETHOD *p_struct, const char *p_src); 325 326 /** Setter. 327 * Use this function to set the member "zkaTanVersion" (see @ref AQFINTS_TANMETHOD_zkaTanVersion) 328 */ 329 void AQFINTS_TanMethod_SetZkaTanVersion(AQFINTS_TANMETHOD *p_struct, const char *p_src); 330 331 /** Setter. 332 * Use this function to set the member "methodName" (see @ref AQFINTS_TANMETHOD_methodName) 333 */ 334 void AQFINTS_TanMethod_SetMethodName(AQFINTS_TANMETHOD *p_struct, const char *p_src); 335 336 /** Setter. 337 * Use this function to set the member "tanMaxLen" (see @ref AQFINTS_TANMETHOD_tanMaxLen) 338 */ 339 void AQFINTS_TanMethod_SetTanMaxLen(AQFINTS_TANMETHOD *p_struct, int p_src); 340 341 /** Setter. 342 * Use this function to set the member "formatId" (see @ref AQFINTS_TANMETHOD_formatId) 343 */ 344 void AQFINTS_TanMethod_SetFormatId(AQFINTS_TANMETHOD *p_struct, int p_src); 345 346 /** Setter. 347 * Use this function to set the member "prompt" (see @ref AQFINTS_TANMETHOD_prompt) 348 */ 349 void AQFINTS_TanMethod_SetPrompt(AQFINTS_TANMETHOD *p_struct, const char *p_src); 350 351 /** Setter. 352 * Use this function to set the member "returnMaxLen" (see @ref AQFINTS_TANMETHOD_returnMaxLen) 353 */ 354 void AQFINTS_TanMethod_SetReturnMaxLen(AQFINTS_TANMETHOD *p_struct, int p_src); 355 356 /** Setter. 357 * Use this function to set the member "maxActiveLists" (see @ref AQFINTS_TANMETHOD_maxActiveLists) 358 */ 359 void AQFINTS_TanMethod_SetMaxActiveLists(AQFINTS_TANMETHOD *p_struct, int p_src); 360 361 /** Setter. 362 * Use this function to set the member "timeShiftAllowed" (see @ref AQFINTS_TANMETHOD_timeShiftAllowed) 363 */ 364 void AQFINTS_TanMethod_SetTimeShiftAllowed(AQFINTS_TANMETHOD *p_struct, int p_src); 365 366 /** Setter. 367 * Use this function to set the member "tanListMode" (see @ref AQFINTS_TANMETHOD_tanListMode) 368 */ 369 void AQFINTS_TanMethod_SetTanListMode(AQFINTS_TANMETHOD *p_struct, int p_src); 370 371 /** Setter. 372 * Use this function to set the member "needSmsAccount" (see @ref AQFINTS_TANMETHOD_needSmsAccount) 373 */ 374 void AQFINTS_TanMethod_SetNeedSmsAccount(AQFINTS_TANMETHOD *p_struct, int p_src); 375 376 /** Setter. 377 * Use this function to set the member "needLocalAccount" (see @ref AQFINTS_TANMETHOD_needLocalAccount) 378 */ 379 void AQFINTS_TanMethod_SetNeedLocalAccount(AQFINTS_TANMETHOD *p_struct, int p_src); 380 381 /** Setter. 382 * Use this function to set the member "initMode" (see @ref AQFINTS_TANMETHOD_initMode) 383 */ 384 void AQFINTS_TanMethod_SetInitMode(AQFINTS_TANMETHOD *p_struct, const char *p_src); 385 386 /** Setter. 387 * Use this function to set the member "needTanMediumId" (see @ref AQFINTS_TANMETHOD_needTanMediumId) 388 */ 389 void AQFINTS_TanMethod_SetNeedTanMediumId(AQFINTS_TANMETHOD *p_struct, int p_src); 390 391 /** Setter. 392 * Use this function to set the member "maxActiveTanMedia" (see @ref AQFINTS_TANMETHOD_maxActiveTanMedia) 393 */ 394 void AQFINTS_TanMethod_SetMaxActiveTanMedia(AQFINTS_TANMETHOD *p_struct, int p_src); 395 396 /** Setter. 397 * Use this function to set the member "runtimeFlags" (see @ref AQFINTS_TANMETHOD_runtimeFlags) 398 */ 399 void AQFINTS_TanMethod_SetRuntimeFlags(AQFINTS_TANMETHOD *p_struct, uint32_t p_src); 400 401 /** Add flags. 402 * Use this function to add flags to the member "runtimeFlags" 403 */ 404 void AQFINTS_TanMethod_AddRuntimeFlags(AQFINTS_TANMETHOD *p_struct, uint32_t p_src); 405 406 /** Sub flags. 407 * Use this function to sub flags from the member "runtimeFlags" 408 */ 409 void AQFINTS_TanMethod_SubRuntimeFlags(AQFINTS_TANMETHOD *p_struct, uint32_t p_src); 410 411 /* list1 functions */ 412 AQFINTS_TANMETHOD_LIST *AQFINTS_TanMethod_List_dup(const AQFINTS_TANMETHOD_LIST *p_src); 413 414 void AQFINTS_TanMethod_ReadDb(AQFINTS_TANMETHOD *p_struct, GWEN_DB_NODE *p_db); 415 416 int AQFINTS_TanMethod_WriteDb(const AQFINTS_TANMETHOD *p_struct, GWEN_DB_NODE *p_db); 417 418 AQFINTS_TANMETHOD *AQFINTS_TanMethod_fromDb(GWEN_DB_NODE *p_db); 419 420 int AQFINTS_TanMethod_toDb(const AQFINTS_TANMETHOD *p_struct, GWEN_DB_NODE *p_db); 421 422 AQFINTS_TANMETHOD *AQFINTS_TanMethod_List_GetByFunction(const AQFINTS_TANMETHOD_LIST *p_list, int p_cmp); 423 424 /* end-headers */ 425 426 427 #ifdef __cplusplus 428 } 429 #endif 430 431 #endif 432 433