The CSA and Open ClientConnect use the SPAREA by putting values into and retrieving values from the SPAREA fields to communicate. The word Reserved in the descriptions indicates that the CSA cannot write to the field.
SPHEADER contains the character string *SPAREA*. The character string serves as an eye catcher for locating the SPAREA in a dump. Reserved.
SPRESRVD contains values used by Open ClientConnect to process commands. Reserved.
Open ClientConnect uses SPSTATUS to indicate the success or failure of processing. This value refers to processing on the remote database. Valid values are:
'OK' indicates success.
'E' indicates an error.
'W' indicates a warning.
'R' indicates results.
Only RSPs use SPCODE. Reserved.
The CSA uses SPFORMAT to specify the data format when opening a data pipe. The only valid value for CSAs is DB2.
The CSA uses SPMODE to specify the mode of the data pipe. The only valid value for CSAs is INPUT.
Open ClientConnect uses SPRC to indicate the success or failure of a CSA command. Valid return codes are:
'000' indicates successful completion.
'xxx' indicates an Open ClientConnect error number.
'EOF' indicates an End of File on input data.
Open ClientConnect uses SPSQLDA to specify the address of a SQLDA that describes the data records. For details, see IBM SQL Reference for DB2.
SPROWS contains the number of rows returned for CSA requests that return data.
Open ClientConnect uses SPPREFIX to provide messages with an appropriate message prefix. Reserved.
Open ClientConnect uses SPMSG to place message text to be retrieved by the CSA with a GETMSG command.
SPFILL2 is used for slack bytes in the SPAREA. Reserved.
The CSA uses SPSQL to specify a pointer to the SQL request buffer containing the SQL statements it is sending to Open ClientConnect.
The CSA uses SPSERVER to provide the name of the LAN-based server on the remote platform to which the CSA connects. The CSA must provide the SPSERVER or the SPATTACH before issuing the ATTACH command.
The CSA uses SPATTACH to provide the name of the Sybase attachment definition to connect to the remote platform for backward compatibility. The CSA must provide SPATTACH or SPSERVER before issuing the ATTACH command.
If the attachment definition is specified but not found in the PCSQLSP file, the attachment name is used as the server name.
The CSA uses SPUSERID to specify a user ID required by the remote database (for example, Adaptive Server Enterprise, DB2, or DBM). For backward compatibility, if the CSA does not specify SPUSERID and a Sybase attachment name is used and found in the PCSQLSP file, the CSA uses the user ID in the attachment definition is used.
The CSA uses SPPWD to specify a password required by the remote database. For backward compatibility, if the CSA does not specify SPPWD and a Sybase attachment name is used and found in the PCSQLSP file, the CSA uses the password in the attachment definition.
SPCMPOPT is no longer used.
Open ClientConnect uses SPIND to inform a CSA that an additional message is available. Valid values are:
M indicates that messages are available.
[Blank] indicates that messages are not available.
Open ClientConnect uses SPDATE to inform a CSA of the date that a request ran. This field contains a value in the form YY/MM/DD.
Open ClientConnect uses SPTIME to inform a CSA of the time that a request ran. This field contains a value in the form HH:MM:SS.
SPCONFIG is no longer used.
The assembler programming language uses SPEND as a label indicating the end of SPAREA. COBOL II, C, and PL/1 SPAREA descriptions do not include SPEND.
SPTRCOPT controls the trace option. If this field contains 'Y' when an Open ClientConnect command is issued, trace records are written to the TSQ, CExxxxxx, where xxxxxx is the first six characters of the user ID.
