doxygen/FL4SEPA/_f_l4_s_e_p_a_8h_source.html

#ifndef INC_FL4SEPA_H

#define INC_FL4SEPA_H


#ifdef __cplusplus

   extern "C" {

#endif


/**********************************************************************/


#ifdef __ZOS__

#  pragma linkage(CLM100NP,   OS_NOSTACK)

#  pragma linkage(CLN100NP,   OS_NOSTACK)

#  pragma linkage(CLM221NP,   OS)

#  pragma linkage(CLN221NP,   OS)

#  pragma linkage(CLM222NP,   OS)

#  pragma linkage(CLN222NP,   OS)

#  pragma linkage(CLM223NP,   OS)

#  pragma linkage(CLN223NP,   OS)

#  pragma linkage(CLU223NP,   OS)

#  pragma linkage(CLX223NP,   OS)

#  pragma linkage(CLG223NP,   OS)

#  pragma linkage(CLM250NP,   OS)

#  pragma linkage(CLN250NP,   OS)

#  pragma linkage(CLU250NP,   OS)

#  pragma linkage(CLX250NP,   OS)

#  pragma linkage(CLG250NP,   OS)

#  pragma linkage(TfCLM100NP, OS)

#  pragma linkage(TfCLN100NP, OS)

#  pragma linkage(TfCLU100NP, OS)

#  pragma linkage(TfCLX100NP, OS)

#  pragma linkage(TfCLG100NP, OS)

#endif


/**********************************************************************/


#include "FL4REC.h"


/**********************************************************************/


#define F4S_MAXANZSF    128U

#define F4S_MAXANZNF    50U


#define F4S_TRAKEYLEN   50U

#define F4S_XMLKEYLEN   33U

#define F4S_XM1OFFSET   8055U

#define F4S_XM2OFFSET   20090U

#define F4S_MAXRECLEN   32125U

#define F4S_CLTEMPLEN   32144U

#define F4S_METAFIELD   30U

#define F4S_LENFIELD    5U

#define F4S_MAXSFLEN    64U

#define F4S_BLOOMCNT    128U

#define F4S_MAXSIGLEN   8192U

#define F4S_DSNAMELEN   44U

#define F4S_DDNAMELEN   8U

#define F4S_RCLEN       2U

#define F4S_ERRTXTLEN   80U


/**********************************************************************/


typedef struct F4sLoad

{

   C08                  acListDataSet[F4S_DSNAMELEN];

   C08                  acAnzDsNames[5];

   C08                  acDdnSig[F4S_DDNAMELEN];

   C08                  acDdnTra[F4S_DDNAMELEN];

   C08                  acDdnXmlI[F4S_DDNAMELEN];

   C08                  acDdnXmlO[F4S_DDNAMELEN];

   C08                  acRc[F4S_RCLEN];

   C08                  acErrorText[F4S_ERRTXTLEN];

} TsF4sLoad;


typedef struct F4sNfHeader

{

   C08                  acIdBt[8];

   C08                  acIdNr[5];

   C08                  acAnzResults[6];

} TsF4sNfHeader;


#define FL4SEPA_VSN21

#include "FL4SEPAS.h"

#undef FL4SEPA_VSN21


#define FL4SEPA_VSN22

#include "FL4SEPAS.h"

#undef FL4SEPA_VSN22


#define FL4SEPA_VSN23

#include "FL4SEPAS.h"

#undef FL4SEPA_VSN23


#define FL4SEPA_VSN50

#include "FL4SEPAS.h"

#undef FL4SEPA_VSN50


typedef union F4sNfTab

{

   TsF4sNfEntry21       asNfe21[F4S_MAXANZNF];

   TsF4sNfEntry22       asNfe22[F4S_MAXANZNF];

   TsF4sNfEntry23       asNfe23[F4S_MAXANZNF];

   TsF4sNfEntry50       asNfe50[F4S_MAXANZNF];

}TuF4sNfTab;


typedef struct F4sSearchIn

{

   C08                  acDsnSig[F4S_DSNAMELEN];

   C08                  acDsnTra[F4S_DSNAMELEN];

   C08                  acDsnXmlI[F4S_DSNAMELEN];

   C08                  acDsnXmlO[F4S_DSNAMELEN];

   C08                  acMaxResults[6];

   C08                  acAnzNf[2];

   TuF4sNfTab           unNfTab;

}TsF4sSearchIn;


typedef struct F4sUpdateIn

{

   C08                  acDelete[1];

   C08                  acDsnUpd[F4S_DSNAMELEN];

   C08                  acDsnSig[F4S_DSNAMELEN];

   C08                  acDsnTra[F4S_DSNAMELEN];

} TsF4sUpdateIn;


typedef struct F4sMigrateIn

{

   C08                  acDsnSig[F4S_DSNAMELEN];

   C08                  acDsnTra[F4S_DSNAMELEN];

} TsF4sMigrateIn;


typedef struct F4sGenerateIn

{

   C08                  acDdnSig[F4S_DDNAMELEN];

   C08                  acDsnTra[F4S_DSNAMELEN];

} TsF4sGenerateIn;


typedef struct F4sOut

{

   C08                  acRc[F4S_RCLEN];

   C08                  acErrorText[F4S_ERRTXTLEN];

}TsF4sOut;


/******************************************************************************/


typedef void (TfCLM100NP)(TsF4sLoad* psPar);


typedef void (TfCLN100NP)(TsF4sSearchIn* psInPar,TsF4sOut* psOutPar);


typedef void (TfCLU100NP)(const TsF4sUpdateIn* psInPar,TsF4sOut* psOutPar);


typedef void (TfCLX100NP)(const TsF4sMigrateIn* psInPar,TsF4sOut* psOutPar);


typedef void (TfCLG100NP)(const TsF4sGenerateIn* psInPar,TsF4sOut* psOutPar);


/******************************************************************************/


extern void CLM100NP(TsF4sLoad* psPar);//Old assembler Entry in Version 21

extern void CLM221NP(TsF4sLoad* psPar);//New C entry in version 21 (same as old assembler)

extern void CLM222NP(TsF4sLoad* psPar);//New C entry in version 22 (new search field REASRTRA)

extern void CLM223NP(TsF4sLoad* psPar);//New C entry in version 23 (change SIGDSN from PS to KSDS for Update)

extern void CLM250NP(TsF4sLoad* psPar);//New C entry in version 23 (change SIGDSN from PS to KSDS for Update)


extern void CLN100NP(TsF4sSearchIn* psInPar,TsF4sOut* psOutPar);//Old assembler Entry in Version 21

extern void CLN221NP(TsF4sSearchIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 21 (same as old assembler)

extern void CLN222NP(TsF4sSearchIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 22 (new search field REASRTRA)

extern void CLN223NP(TsF4sSearchIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (change SIGDSN from PS to KSDS for Update)

extern void CLN250NP(TsF4sSearchIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (change SIGDSN from PS to KSDS for Update)


extern void CLU223NP(TsF4sUpdateIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (new update function)

extern void CLU250NP(TsF4sUpdateIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (new update function)


extern void CLX223NP(TsF4sMigrateIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (new migrate function)

extern void CLX250NP(TsF4sMigrateIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (new migrate function)


extern void CLG223NP(TsF4sGenerateIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (new migrate function)

extern void CLG250NP(TsF4sGenerateIn* psInPar,TsF4sOut* psOutPar);//New C entry in version 23 (new migrate function)


/* Proposal for new search field independent interface ************************/


#define F4S_SFMTD_VERSN    "VERSN"

#define F4S_SFMTD_RESRV    "RESRV"

#define F4S_SFMTD_PRDAY    "PRDAY"

#define F4S_SFMTD_SYSTM    "SYSTM"

#define F4S_SFMTD_SVCID    "SVCID"

#define F4S_SFMTD_BF32N    "BF32N"

#define F4S_SFMTD_BF48N    "BF48N"

#define F4S_SFMTD_BF32I    "BF32I"

#define F4S_SFMTD_BF48I    "BF48I"

#define F4S_SFMTD_NOSIG    "NOSIG"


#define F4S_SFTYP_BIN      "B"

#define F4S_SFTYP_NUM      "N"

#define F4S_SFTYP_STR      "S"


#define F4S_SFWC_YES       "Y"

#define F4S_SFWC_NO        "N"


typedef struct F4sSfTab {

// C08                     acName[16];                   /**< @brief Logical name for the search filed*/

   C08                     acMethod[5];

   C08                     acDatTyp[1];

   C08                     acWldCrd[1];

   C08                     acResrvd[1];

   U32                     uiDatOfs;

   U32                     uiDatLen;

   U32                     uiSigLen;

}TsF4sSfTab;


typedef struct F4sLoadInp

{

   C08                     acListDataSet[F4S_DSNAMELEN];

   C08                     acAnzDsNames[5];

   C08                     acDdnSig[F4S_DDNAMELEN];

   C08                     acDdnTra[F4S_DDNAMELEN];

   C08                     acDdnXmlI[F4S_DDNAMELEN];

   C08                     acDdnXmlO[F4S_DDNAMELEN];

   C08                     acAnzSf[4];

} TsF4sLoadInp;


typedef struct F4sSearchInp

{

   C08                     acDsnSig[F4S_DSNAMELEN];

   C08                     acDsnTra[F4S_DSNAMELEN];

   C08                     acDsnXmlI[F4S_DSNAMELEN];

   C08                     acDsnXmlO[F4S_DSNAMELEN];

   C08                     acMaxResults[6];

   C08                     acAnzSf[4];

   C08                     acAnzNf[2];

}TsF4sSearchInp;


typedef struct F4sSearchIds

{

   C08                     acIdBt[8];

   C08                     acIdNr[5];

   C08                     acAnzResults[6];

   C08                     acAnzSf[4];

}TsF4sSearchIds;


typedef struct F4sSearchFields

{

   U32                     uiIndex;

// C08                     acName[16];                   /**< @brief Name for the search field*/

   C08                     acValue[F4S_MAXSFLEN];

}TsF4sSearchFields;


typedef struct F4sUpdateInp

{

   C08                     acDelete[1];

   C08                     acUpdTra[F4S_DSNAMELEN];

   C08                     acDsnSig[F4S_DSNAMELEN];

   C08                     acDsnTra[F4S_DSNAMELEN];

   C08                     acAnzSf[4];

} TsF4sUpdateInp;


typedef struct F4sMigrateInp

{

   C08                     acDsnSig[F4S_DSNAMELEN];

   C08                     acDsnTra[F4S_DSNAMELEN];

   C08                     acAnzSf[4];

} TsF4sMigrateInp;


typedef struct F4sGenerateInp

{

   C08                     acDdnSig[F4S_DDNAMELEN];

   C08                     acDsnTra[F4S_DSNAMELEN];

   C08                     acAnzSf[4];

} TsF4sGenerateInp;


//New C entry in version 24 for load

extern void CLM224NP(

   const TsF4sSfTab*       psSfTab,

   const TsF4sLoadInp*     psInpPar,

   TsF4sOut*               psOutPar);


//New C entry in version 24 for lookup

extern void CLN224NP(

   const TsF4sSfTab*       psSfTab,

   const TsF4sSearchInp*   psInpPar,

   TsF4sSearchIds*         psIds,

   const TsF4sSearchFields*psFields,

   TsF4sOut*               psOutPar);


//New C entry in version 24 for update

extern void CLU224NP(

   const TsF4sSfTab*       psSfTab,

   const TsF4sUpdateInp*   psInpPar,

   TsF4sOut*               psOutPar);


//New C entry in version 24 for migrate

extern void CLX224NP(

   const TsF4sSfTab*       psSfTab,

   const TsF4sMigrateInp*  psInpPar,

   TsF4sOut*               psOutPar);


//New C entry in version 24 for generate

extern void CLG224NP(

   const TsF4sSfTab*       psSfTab,

   const TsF4sGenerateInp* psInpPar,

   TsF4sOut*               psOutPar);


#ifdef __cplusplus

   }

#endif


#endif /*INC_FL4SEPA_H*/

FL4SEPAS.h

F4S_ERRTXTLEN
#define F4S_ERRTXTLEN
Space for the error text.
Definition FL4SEPA.h:136

F4S_RCLEN
#define F4S_RCLEN
Space for the return code.
Definition FL4SEPA.h:135

F4S_DSNAMELEN
#define F4S_DSNAMELEN
Space for data set names.
Definition FL4SEPA.h:133

F4S_MAXSFLEN
#define F4S_MAXSFLEN
Maximum length of a search field.
Definition FL4SEPA.h:130

F4S_DDNAMELEN
#define F4S_DDNAMELEN
Space for DD names.
Definition FL4SEPA.h:134

F4S_MAXANZNF
#define F4S_MAXANZNF
Maximum number of lookups per call.
Definition FL4SEPA.h:120

TfCLM100NP
void TfCLM100NP(TsF4sLoad *psPar)
Load function.
Definition FL4SEPA.h:489

TfCLN100NP
void TfCLN100NP(TsF4sSearchIn *psInPar, TsF4sOut *psOutPar)
Lookup function.
Definition FL4SEPA.h:499

TfCLX100NP
void TfCLX100NP(const TsF4sMigrateIn *psInPar, TsF4sOut *psOutPar)
Migrate function.
Definition FL4SEPA.h:520

TfCLG100NP
void TfCLG100NP(const TsF4sGenerateIn *psInPar, TsF4sOut *psOutPar)
Generate function.
Definition FL4SEPA.h:530

TfCLU100NP
void TfCLU100NP(const TsF4sUpdateIn *psInPar, TsF4sOut *psOutPar)
Update function.
Definition FL4SEPA.h:510

TsF4sLoad
struct F4sLoad TsF4sLoad
Parameter structure to load an archive.

TsF4sNfEntry21
struct F4sNfEntry21 TsF4sNfEntry21
Parameter structure to define the search field for an research in an archive.

TsF4sNfHeader
struct F4sNfHeader TsF4sNfHeader
Header structure for a lookup request.

TsF4sMigrateIn
struct F4sMigrateIn TsF4sMigrateIn
Input parameter structure to migrate the signature file of the SEPA archive.

TsF4sGenerateIn
struct F4sGenerateIn TsF4sGenerateIn
Input parameter structure to generate the signature file of the SEPA archive.

TsF4sUpdateIn
struct F4sUpdateIn TsF4sUpdateIn
Input parameter structure to update records in or delete from an archive.

TsF4sSearchIn
struct F4sSearchIn TsF4sSearchIn
Input parameter structure for lookups in an archive.

TuF4sNfTab
union F4sNfTab TuF4sNfTab
Overlay/Union for the different request structure arrays.

TsF4sOut
struct F4sOut TsF4sOut
Output structure.

F4sGenerateIn
Input parameter structure to generate the signature file of the SEPA archive.
Definition FL4SEPA.h:404

F4sGenerateIn::acDsnTra
C08 acDsnTra[F4S_DSNAMELEN]
DSN for transaction FLAMFILE of SEPA archive.
Definition FL4SEPA.h:406

F4sGenerateIn::acDdnSig
C08 acDdnSig[F4S_DDNAMELEN]
DDN for signature FLAMFILE of SEPA archive.
Definition FL4SEPA.h:405

F4sLoad
Parameter structure to load an archive.
Definition FL4SEPA.h:202

F4sLoad::acDdnSig
C08 acDdnSig[F4S_DDNAMELEN]
DDNAME for the signature file.
Definition FL4SEPA.h:205

F4sLoad::acDdnXmlI
C08 acDdnXmlI[F4S_DDNAMELEN]
DDNAME for the SEPA XML inbound file.
Definition FL4SEPA.h:207

F4sLoad::acRc
C08 acRc[F4S_RCLEN]
Return code.
Definition FL4SEPA.h:209

F4sLoad::acErrorText
C08 acErrorText[F4S_ERRTXTLEN]
Error text.
Definition FL4SEPA.h:210

F4sLoad::acDdnXmlO
C08 acDdnXmlO[F4S_DDNAMELEN]
DDNAME for the SEPA XML outbound file.
Definition FL4SEPA.h:208

F4sLoad::acAnzDsNames
C08 acAnzDsNames[5]
Number of FLAMFILES contained in / read from the list dataset.
Definition FL4SEPA.h:204

F4sLoad::acListDataSet
C08 acListDataSet[F4S_DSNAMELEN]
Name of the list dataset.
Definition FL4SEPA.h:203

F4sLoad::acDdnTra
C08 acDdnTra[F4S_DDNAMELEN]
DDNAME for the transaction file.
Definition FL4SEPA.h:206

F4sMigrateIn
Input parameter structure to migrate the signature file of the SEPA archive.
Definition FL4SEPA.h:379

F4sMigrateIn::acDsnTra
C08 acDsnTra[F4S_DSNAMELEN]
DSN for transaction FLAMFILE of SEPA archive.
Definition FL4SEPA.h:381

F4sMigrateIn::acDsnSig
C08 acDsnSig[F4S_DSNAMELEN]
DSN for signature FLAMFILE of SEPA archive.
Definition FL4SEPA.h:380

F4sNfHeader
Header structure for a lookup request.
Definition FL4SEPA.h:233

F4sNfHeader::acIdNr
C08 acIdNr[5]
ID sequence number.
Definition FL4SEPA.h:235

F4sNfHeader::acIdBt
C08 acIdBt[8]
ID of the build day.
Definition FL4SEPA.h:234

F4sNfHeader::acAnzResults
C08 acAnzResults[6]
Number of results/matches.
Definition FL4SEPA.h:236

F4sOut
Output structure.
Definition FL4SEPA.h:468

F4sOut::acRc
C08 acRc[F4S_RCLEN]
Definition FL4SEPA.h:469

F4sOut::acErrorText
C08 acErrorText[F4S_ERRTXTLEN]
Definition FL4SEPA.h:470

F4sSearchIn
Input parameter structure for lookups in an archive.
Definition FL4SEPA.h:308

F4sSearchIn::acAnzNf
C08 acAnzNf[2]
Number of lookup requests.
Definition FL4SEPA.h:314

F4sSearchIn::acMaxResults
C08 acMaxResults[6]
Limit the number of results (0 = unlimited)
Definition FL4SEPA.h:313

F4sSearchIn::acDsnXmlO
C08 acDsnXmlO[F4S_DSNAMELEN]
DSN for XML outbound FLAMFILE of SEPA archive.
Definition FL4SEPA.h:312

F4sSearchIn::acDsnSig
C08 acDsnSig[F4S_DSNAMELEN]
DSN for signature FLAMFILE of SEPA archive.
Definition FL4SEPA.h:309

F4sSearchIn::acDsnTra
C08 acDsnTra[F4S_DSNAMELEN]
DSN for transaction FLAMFILE of SEPA archive.
Definition FL4SEPA.h:310

F4sSearchIn::unNfTab
TuF4sNfTab unNfTab
Table containing the lookup requests.
Definition FL4SEPA.h:315

F4sSearchIn::acDsnXmlI
C08 acDsnXmlI[F4S_DSNAMELEN]
DSN for XML inbound FLAMFILE of SEPA archive.
Definition FL4SEPA.h:311

F4sUpdateIn
Input parameter structure to update records in or delete from an archive.
Definition FL4SEPA.h:348

F4sUpdateIn::acDsnSig
C08 acDsnSig[F4S_DSNAMELEN]
DSN for signature FLAMFILE of SEPA archive.
Definition FL4SEPA.h:351

F4sUpdateIn::acDsnTra
C08 acDsnTra[F4S_DSNAMELEN]
DSN for transaction FLAMFILE of SEPA archive.
Definition FL4SEPA.h:352

F4sUpdateIn::acDsnUpd
C08 acDsnUpd[F4S_DSNAMELEN]
Name of the FLAMFILE containing the records for update.
Definition FL4SEPA.h:350

F4sUpdateIn::acDelete
C08 acDelete[1]
Set to 'Y' will delete the record, anything else will update the record.
Definition FL4SEPA.h:349

F4sNfTab
Overlay/Union for the different request structure arrays.
Definition FL4SEPA.h:279

F4sNfTab::asNfe50
TsF4sNfEntry50 asNfe50[F4S_MAXANZNF]
The version 2.3 request structure (identical to 2.2 but new signature format (FL5))
Definition FL4SEPA.h:283

F4sNfTab::asNfe23
TsF4sNfEntry23 asNfe23[F4S_MAXANZNF]
The version 2.3 request structure (identical to 2.2 but new behavior for update)
Definition FL4SEPA.h:282

F4sNfTab::asNfe22
TsF4sNfEntry22 asNfe22[F4S_MAXANZNF]
The version 2.2 request structure.
Definition FL4SEPA.h:281

F4sNfTab::asNfe21
TsF4sNfEntry21 asNfe21[F4S_MAXANZNF]
The version 2.1 request structure.
Definition FL4SEPA.h:280