FCPE-SPI FLAM Column Processing Exit (FCPE) Service Provider Interface (SPI)

FCPE.h
Go to the documentation of this file.
1
210#ifdef __cplusplus
211 extern "C" {
212#endif
213
214#ifndef INC_FCPE_H
215#define INC_FCPE_H
218/**********************************************************************/
219
220#include"FLMRTC.h"
221#include"FLMDEF.h"
222
223/**********************************************************************/
224
236#define FCPE_FUNC_OPN 1
237#define FCPE_FUNC_RUN 2
238#define FCPE_FUNC_CLS 3
250#define FCPE_DEFLIB_NAME "libfcpe"
251#define FCPE_DEFFUC_NAME "FLAMCPE"
263#define FCPE_CMBFRM_NON 0U
264#define FCPE_CMBFRM_NFD 1U
265#define FCPE_CMBFRM_NFC 2U
276 #define FCPE_FLAG_WRITE 0x00000001U
277 #define FCPE_FLAG_NOCPY 0x00000002U
280/**********************************************************************/
281
324 typedef struct FcpeOpn {
326 unsigned int uiFlg;
328 unsigned int uiCcs;
330 unsigned int uiTab;
332 unsigned int uiDy1;
334 const char* pcTab;
336 unsigned int uiCol;
338 unsigned int uiDy2;
340 const char* pcCol;
342 unsigned int uiPar;
344 unsigned int uiDy3;
346 const char* pcPar;
348 unsigned int uiIvr;
350 unsigned int uiDy4;
352 char* pcIvr;
354 unsigned int uiMsg;
356 unsigned int uiDy5;
358 char acMsg[1024];
359}TsFcpeOpn;
360
401 typedef struct FcpeRun {
403 unsigned int uiInp;
405 unsigned int uiDy1;
407 unsigned char* pcInp;
409 unsigned int uiOut;
411 unsigned int uiDy2;
413 unsigned char* pcOut;
415 unsigned int uiFlg;
417 unsigned int uiMsg;
419 char acMsg[1024];
420}TsFcpeRun;
421
432 typedef struct FcpeCls {
434 unsigned int uiMsg;
436 unsigned int uiDy1;
438 char acMsg[1024];
439}TsFcpeCls;
440
448 typedef union FcpePar {
450 TsFcpeOpn stOpn;
452 TsFcpeRun stRun;
454 TsFcpeCls stCls;
455}TuFcpePar;
458/**********************************************************************/
459
485 typedef void (TfFcpExit)(
486 void** ppHdl,
487 int* piRetco,
488 const int* piFunc,
489 TuFcpePar* puPara);
492/**********************************************************************/
493
495#endif /* INC_FCPE_H */
496
497#ifdef __cplusplus
498 }
499#endif
FLMDEF.h
FLMDEF - External FLAM definitions.
FLMRTC.h
FLMRTC - FLAM-Return-Codes.
TsFcpeOpn
struct FcpeOpn TsFcpeOpn
FCPE parameter structure for function code FCPE_FUNC_OPN.
TsFcpeRun
struct FcpeRun TsFcpeRun
FCPE Run structure.
TuFcpePar
union FcpePar TuFcpePar
FCPE Union of function structures.
TsFcpeCls
struct FcpeCls TsFcpeCls
FCPE Close structure.
TfFcpExit
void() TfFcpExit(void **ppHdl, int *piRetco, const int *piFunc, TuFcpePar *puPara)
FCPE function.
Definition: FCPE.h:485
FcpeCls
FCPE Close structure.
Definition: FCPE.h:432
FcpeCls::uiMsg
unsigned int uiMsg
[OUTPUT] Length of error message (32 bit word)
Definition: FCPE.h:434
FcpeCls::acMsg
char acMsg[1024]
[OUTPUT] Maximal 1024 byte long error string
Definition: FCPE.h:438
FcpeCls::uiDy1
unsigned int uiDy1
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:436
FcpeOpn
FCPE parameter structure for function code FCPE_FUNC_OPN.
Definition: FCPE.h:324
FcpeOpn::uiTab
unsigned int uiTab
[INPUT] Length of the table name (32 bit word)
Definition: FCPE.h:330
FcpeOpn::uiFlg
unsigned int uiFlg
[INOUT] Flag word (32 bit) with several bit settings
Definition: FCPE.h:326
FcpeOpn::uiDy5
unsigned int uiDy5
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:356
FcpeOpn::acMsg
char acMsg[1024]
[OUTPUT] Maximal 1024 byte long error string
Definition: FCPE.h:358
FcpeOpn::uiIvr
unsigned int uiIvr
[OUTPUT] Length of the inverse parameter string (32 bit word)
Definition: FCPE.h:348
FcpeOpn::uiDy1
unsigned int uiDy1
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:332
FcpeOpn::pcIvr
char * pcIvr
[OUTPUT] Pointer to the inverse parameter string (32 or 64 bit)
Definition: FCPE.h:352
FcpeOpn::uiPar
unsigned int uiPar
[INPUT] Length of the parameter string (32 bit word)
Definition: FCPE.h:342
FcpeOpn::uiDy2
unsigned int uiDy2
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:338
FcpeOpn::uiCcs
unsigned int uiCcs
[INOUT] CCSID in first low order 24 bit and the and combined character form in the high order 8 bit
Definition: FCPE.h:328
FcpeOpn::uiMsg
unsigned int uiMsg
[OUTPUT] Length of error message (32 bit word)
Definition: FCPE.h:354
FcpeOpn::pcCol
const char * pcCol
[INPUT] Pointer to the column name (32 or 64 bit)
Definition: FCPE.h:340
FcpeOpn::uiCol
unsigned int uiCol
[INPUT] Length of the column name (32 bit word)
Definition: FCPE.h:336
FcpeOpn::uiDy3
unsigned int uiDy3
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:344
FcpeOpn::pcTab
const char * pcTab
[INPUT] Pointer to the table name (32 or 64 bit)
Definition: FCPE.h:334
FcpeOpn::uiDy4
unsigned int uiDy4
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:350
FcpeOpn::pcPar
const char * pcPar
[INPUT] Pointer to the parameter string (32 or 64 bit)
Definition: FCPE.h:346
FcpeRun
FCPE Run structure.
Definition: FCPE.h:401
FcpeRun::uiDy1
unsigned int uiDy1
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:405
FcpeRun::pcInp
unsigned char * pcInp
[INPUT] Pointer to the input data (32 or 64 bit)
Definition: FCPE.h:407
FcpeRun::uiOut
unsigned int uiOut
[INOUT] Output space at input and output length at output (32 bit word)
Definition: FCPE.h:409
FcpeRun::uiDy2
unsigned int uiDy2
[DUMMY] 32 bit dummy field for 64 bit alignment
Definition: FCPE.h:411
FcpeRun::uiFlg
unsigned int uiFlg
[INOUT] Flag word for null, empty and other indications (32 bit word) (output at read,...
Definition: FCPE.h:415
FcpeRun::pcOut
unsigned char * pcOut
[OUTPUT] Pointer to the output data (32 or 64 bit)
Definition: FCPE.h:413
FcpeRun::acMsg
char acMsg[1024]
[OUTPUT] Maximal 1024 byte long error string
Definition: FCPE.h:419
FcpeRun::uiInp
unsigned int uiInp
[INPUT] Length of the input data (32 bit word)
Definition: FCPE.h:403
FcpeRun::uiMsg
unsigned int uiMsg
[OUTPUT] Length of error message (32 bit word)
Definition: FCPE.h:417
FcpePar
FCPE Union of function structures.
Definition: FCPE.h:448
FcpePar::stRun
TsFcpeRun stRun
[INOUT] Structure for function code FCPE_FUNC_RUN
Definition: FCPE.h:452
FcpePar::stOpn
TsFcpeOpn stOpn
[INOUT] Structure for function code FCPE_FUNC_OPN
Definition: FCPE.h:450
FcpePar::stCls
TsFcpeCls stCls
[INOUT] Structure for function code FCPE_FUNC_CLS
Definition: FCPE.h:454