The following list shows the input parameters for the
exit. Both C (ARSCSXIT) and COBOL (ARSCSXIC) field definitions are
provided, with the C definitions appearing first. Do not attempt to
access storage beyond the terminating X'00' for string values. The
exit should not modify any input parameters except the output file
name.
- prep->pUserid
- ArsCSXitPrepExit-pUserid
- Contains the address of the null delimited userid requesting the
document.
- prep->pInFileName
- ArsCSXitPrepExit-pInFileName
- Contains the address of the null delimited absolute file name
of the HFS file containing the document as retrieved by Content Manager OnDemand.
- prep->OutFileName
- ArsCSXitPrepExit-OutFileName
- To alter the document presented to the user, set this field to
the null delimited absolute file name of the HFS file containing the
document.
- prep->pUserParms
- ArsCSXitPrepExit-pUserParms
- A pointer to the null delimited user parameters. These parameters
are specified on the Miscellaneous Options page
of the application by using the Content Manager OnDemand administrative
client.
- prep->pApplGrp
- ArsCSXitPrepExit-pApplGrp
- A pointer to the ArcCSXitApplGroup for the application group that
is associated with the document that the user is requesting.
- prep->pAppl
- ArsCSXitPrepExit-pAppl
- A pointer to the ArcCSXitAppl for the application that is associated
with the document that the user is requesting.
- prep->pDoc
- ArsCSXitPrepExit-pDoc
- A pointer to the ArcCSXitDoc for the document that the user is
requesting.
The following list shows the fields in the ArcCSXitApplGroup:
- name
- ArcCSXitApplGroup-namep
- Contains the address of the null delimited application group name.
- agid
- ArcCSXitApplGroup-agid
- Contains the full word application group identifier.
- agid_name
- ArcCSXitApplGroup-agid-namep
- Contains the address of the null delimited internal group name.
The following list shows the fields in the ArcCSXitAppl.
- name
- ArcCSXitAppl-name
- Contains the address of the null delimited application name.
- aid
- ArcCSXitAppl-aid
- Contains the full word application identifier.
- doc-type
- ArcCSXitAppl-type
- Contains a one byte document type indicator.
- doc-fmt
- ArcCSXitAppl-doc-fmt
- For line data documents, contains a one byte document format indicator.
- u.fixed
- ArcCSXitAppl-fixed
- For fixed format line data documents, contains a fullword that
is the line length for each record.
- u.stream
- ArcCSXitAppl-stream
- For stream format line data documents, contains a null-delimited
string that is the end of record indicator. Note that this indicator
may be more than one byte.
- trc_present
- ArcCSXitAppl-trc-present
- A one-byte document indicator that a table reference character
is present (1) or not (0). Only valid for line data.
- line_count
- ArcCSXitAppl-line-count
- A full word count of the lines per page. Only valid for line data.
- code_page
- ArcCSXitAppl-code-page
- A full word containing the code page that is associated with the
data. Only valid for line data.
- cc_type
- ArcCSXitAppl-cc-type
- A one byte indicator of the carriage control. Only
- prmode
- ArcCSXitAppl-prmode
- For an SCS or line data document, if the document contains shift-out
and shift-in codes, this field determines the processing mode for
the document.
The following list shows the valid document
types:
- ARCCSXIT_DOC_TYPE_AFP
- ArcCSXitAppl-type-afp
- AFP
- ARCCSXIT_DOC_TYPE_BMP
- ArcCSXitAppl-type-bmp
- Bitmap
- ARCCSXIT_DOC_TYPE_EMAIL
- ArcCSXitAppl-type-email
- E-mail
- ARCCSXIT_DOC_TYPE_GIF
- ArcCSXitAppl-type-gif
- GIF
- ARCCSXIT_DOC_TYPE_JFIF
- ArcCSXitAppl-type-jfif
- JFIF
- ARCCSXIT_DOC_TYPE_LINE
- ArcCSXitAppl-type-line
- Line data
- ARCCSXIT_DOC_TYPE_META
- ArcCSXitAppl-type-meta
- Metacode
- ARCCSXIT_DOC_TYPE_PCX
- ArcCSXitAppl-type-pcx
- PCX
- ARCCSXIT_DOC_TYPE_PDF
- ArcCSXitAppl-type-pdf
- PDF
- ARCCSXIT_DOC_TYPE_PNG
- ArcCSXitAppl-type-png
- PNG
- ARCCSXIT_DOC_TYPE_SCS
- ArcCSXitAppl-type-scs
- SCS
- ARCCSXIT_DOC_TYPE_SCS_EXT
- ArcCSXitAppl-type-scs-ex
- SCS extended
- ARCCSXIT_DOC_TYPE_TIFF
- ArcCSXitAppl-type-tiff
- TIFF
- ARCCSXIT_DOC_TYPE_USRDEF
- ArcCSXitAppl-type-usrdef
- User defined
The following list shows the valid document
formats for line data:
- ARCCSXIT_DOC_FORMAT_FIXED
- ArcCSXitAppl-doc-fmt-fixed
- The document is stored as fixed length records.
- ARCCSXIT_DOC_FORMAT_VARIABLE
- ArcCSXitAppl-doc-fmt-variable
- The document is stored as a series of records consisting of a
two-byte length followed by the actual record. The length does not
include the two-byte length.
- ARCCSXIT_DOC_FORMAT_STREAM
- ArcCSXitAppl-doc-fmt-stream
- The document is stored as a series of records delimited by a stream
delimiter character sequence.
The following list shows the valid carriage
control:
- ARCCSXIT_CC_ANSI
- ArcCSXitAppl-cc-ansi
- ANSI Carriage control
- ARCCSXIT_CC_MACHINE
- ArcCSXitAppl-cc-machine
- Machine Carriage control
- ARCCSXIT_CC_NONE
- ArcCSXitAppl-cc-none
- No carriage control
The following list shows the valid processing
modes:
- ARCCSXIT_PRMODE_NONE
- ArcCSXitAppl-pr-none
- The document does not contain shift-out and shift-in characters.
- ARCCSXIT_PRMODE_SOSI1
- ArcCSXitAppl-pr-sosi1
- Shift-out and shift-in characters are replaced with a blank.
- ARCCSXIT_PRMODE_SOSI2
- ArcCSXitAppl-pr-sosi2
- Shift-out and shift-in characters are removed.
- ARCCSXIT_PRMODE_SOSI3
- ArcCSXitAppl-pr-sosi3
- Shift-out and shift-in characters are replaced with two blanks.
The following list shows the fields in ArcCSXitDoc:
- doc_flds.flds_num
- ArcCSXitDoc-flds-num
- A full word containing the number of index fields that are associated
with the document.
- doc_flds.flds
- ArcCSXitDoc-flds
- Contains a pointer to the ArcCSXitField table for the document.
This table consists of one entry for each index field, containing
the database column name and value for index.
- doc_hndl.name
- ArcCSXitDoc-name
- Null delimited internal document name for this document (for example,
23FAAC)
- doc_hndl.doc_off
- ArcCSXitDoc-doc-off
- Offset of the document within the decompressed object.
- doc_hndl.doc_len
- ArcCSXitDoc-doc-len
- Length of the document within the decompressed object.
- doc_hndl.comp_off
- ArcCSXitDoc-comp-off
- Offset of the compressed object within the object.
- doc_hndl.comp_len
- ArcCSXitDoc-comp-len
- Length of the compressed object within the object.
The following list shows the fields in the ArcCSXitField
table:
- db-name
- ArcCSXitField-db-namep
- A pointer to the null delimited database column name.
- type
- ArcCSXitField-type
- A one byte indicator for the type of the data base field type.
- qual
- ArcCSXitField-qual
- Indicates if the field is a date/time value and if so, what type.
- u.d
- ArcCSXitField-d
- Double precision floating point value.
- u.b
- ArcCSXitField-b
- Eight-byte integer value.
- u.i
- ArcCSXitField-i
- Four-byte integer value.
- u.n
- ArcCSXitField-n
- Two-byte integer value.
- u.str
- ArcCSXitField-strp
- Address of the null delimited string.
The following list shows the database field
types:
- ARCCSXIT_FIELD_TYPE_BIGINT
- ArcCSXitField-type-bigint
- Eight byte integer.
- ARCCSXIT_FIELD_TYPE_DECIMAL
- ArcCSXitField-type-decimal
- Double precision floating point.
- ARCCSXIT_FIELD_TYPE_INTEGER
- ArcCSXitField-type-integer
- Four byte signed integer.
- ARCCSXIT_FIELD_TYPE_SMALLINT
- ArcCSXitField-type-smallint
- Two byte signed integer.
- ARCCSXIT_FIELD_TYPE_STRING
- ArcCSXitField-type-string
- Null delimited string.
The following shows the database field qualifiers:
- ARCCSXIT_FIELD_TYPE_QUAL_BASE
- ArcCSXitField-qual-base
- Not a date/time value.
- ARCCSXIT_FIELD_TYPE_QUAL_DATETIME
- ArcCSXitField-qual-datetime
- Represents a date/time value.
- ARCCSXIT_FIELD_TYPE_QUAL_DATE
- ArcCSXitField-qual-date
- Represents a date value.
- ARCCSXIT_FIELD_TYPE_QUAL_TIME
- ArcCSXitField-qual-time
- Represents a time value.
- ARCCSXIT_FIELD_TYPE_QUAL_TZ_DATETIME
- ArcCSXitField-qual-tz-datetime
- Represents a local date/time value.