Queries the Shift Out/Shift In (SO/SI) processing settings for a column or parameter.
This function is used with the Japanese Conversion Module
(JCM).
%INCLUDE SYGWPLI;
01 TDPROC PTR, 01 RETCODE FIXED BIN(31), 01 OBJECT_TYPE FIXED BIN(31), 01 OBJECT_NUMBER FIXED BIN(31), 01 STRIP_SOSI FIXED BIN(31);
CALL TDGETSOI (TDPROC, RETCODE, OBJECT_TYPE,
OBJECT_NUMBER, STRIP_SOSI);
(I) Handle for this client/server connection. This must be the same value specified in the associated TDACCEPT call. The TDPROC handle corresponds to the connection and command handles in Open Client Client-Library.
(O) Variable where the result of function execution is returned. Its value is one of the codes listed in Table 3-10.
(I) Type of object to be checked. This argument specifies which type of object is checked by this call: a column in a return row or a return parameter.
Assign OBJECT_TYPE one of the following values:
TDS_OBJECT_COL(1) |
Object is a column in a return row. |
TDS_OBJECT_PARM (2) |
Object is a return parameter. |
(I) Order number of the column or parameter being checked.
If the object is a column, this is the position of the column in the row, counting from left to right. Columns are numbered sequentially with the leftmost column in a row number 1.
If the object is a return parameter, this is the number of the parameter with the value that is being checked. All parameters are counted, whether or not they are return parameters. Parameters are numbered sequentially with the first parameter number 1.
(O) The SO/SI processing setting being used for this column or parameter.
STRIP_SOSI returns one of the following values:
TDS_STRIP_SOSI (0) |
SO/SI codes are stripped before being sent to the client. This is the default. |
TDS_BLANK_SOSI (1) |
SO/SI codes are converted to blanks before being sent to the client. |
The RETCODE argument can contain any of the return values listed in Table 3-10.
Return value |
Meaning |
|---|---|
TDS_OK (0) |
Function completed successfully. |
TDS_ENTRY_NOT_FOUND (-8) |
The specified column number, transaction number, or parameter does not exist. |
TDS_INVALID_FLAGS (-176) |
Invalid padding option for a field. |
TDS_INVALID_PARAMETER (-4) |
Invalid parameter value. The value assigned to one or more of the arguments supplied in the call is not valid. The operation failed. |
TDS_INVALID_TDPROC (-18) |
Error in specifying a value for the TDPROC argument. |
Use TDGETSOI to determine whether SO/SI codes in double-byte character strings are stripped or converted to blanks before results are returned to the client.
SO/SI codes are used with character datatypes to set off double-byte characters. Graphic datatypes do not use SO/SI codes.
Replacing SO/SI codes with blanks maintains the length of the string. Otherwise, if SO/SI codes are stripped, the result length is shorter than the source length.
For more information about Shift Out and Shift In codes, read “Character sets” and “Processing Japanese client requests”.
Related functions
Related topics
