Parameter Properties
Use the Parameter properties page to set the array, host, COBOL design, and recordset properties on a parameter.
Array Properties
| Use this | To do this |
|---|---|
| Array Dimensions | Use this control to indicate how many dimensions (Visual C++ or Visual Basic) or nested OCCURS clauses (COBOL) that the array or table contains. |
| Is Array | Select this option to indicate whether the parameter is an array. The possible values are: - True. Parameter is an array. - False. The item is a simple data type including RDA recordset objects. (default). |
| Occurs Depending On | Select this option to indicate that a numeric data item preceding the table (recordset or array in Automation) indicates the actual number of rows or elements being sent or received. Use the drop-down list to select which numeric data item specifies this value. For CICS Link, the recordset or array and the associated length specifier must be in/out. The data in the buffer that follows a variable length table immediately follows the last data item in the table regardless of the maximum size specified for the table. For arrays with multiple dimensions, it can only be used for the outermost loop (COBOL) or rightmost dimension (Visual C++ or Visual Basic). The RPG language, unlike COBOL, does not directly support Occurs Depending On. TI provides a feature that replicates the Occurs Depending On action for the RPG language. A TI Project supports a single level of dimension applied as an Occurs Depending On associated with a array of records in RPG. An index parameter must be defined prior to defining the parameter associated with a datatable or structure for the parameter to show as an Occurs Depending On selectable choice. |
Host Properties
| Use this | To do this |
|---|---|
| Host Data Type | Specifies the parameter host data type. |
| Error Handling | Parameter error handling. The possible values are: - Truncate. If selected and an error occurs, TI will truncate the value. (default) - Round. If selected and an error occurs, TI will round the value. - Error. If selected and an error occurs, TI will return an error. |
| Filler | Indicates the number of bytes of FILLER that follow this data item in the buffers that are sent to or received from the host. FILLER causes an untranslated gap in the buffer. FILLER is not visible on the Automation side. |
| From Host | Indicates the number of bytes of FILLER that follows this data item in the buffers that are received from the server. FILLER causes an untranslated gap in the buffer. FILLER is not visible on the Automation side. |
| To Host | Indicates the number of bytes of FILLER that follows this data item in the buffers that are sent to the server. FILLER causes an untranslated gap in the buffer. FILLER is not visible on the Automation side. |
| Scale | The parameter scale. |
| Sign Attribute | Parameter sign attribute. The possible values are: - Trailing. For signed DISPLAY data type, indicates that the sign is trailing (default). This option indicates to the TI run-time environment how a signed DISPLAY data type is formatted and affects how data from the host is converted to and from the Automation data type. - Trailing Separate. For signed DISPLAY data type, indicates that the sign is separate. This option indicates to the TI run-time environment how a signed DISPLAY data type is formatted and affects how data from the host is converted to and from the Automation data type. - Leading. For signed DISPLAY data type, indicates that the sign is leading. This option indicates to the TI run-time environment how a signed DISPLAY data type is formatted and affects how data from the host is converted to and from the Automation data type. - Leading Separate. For signed DISPLAY data type, indicates that the sign is separate. |
| Size | Specifies the length of the string. |
| SOSI | Specifies whether double-byte character set data is expected to begin with a shift-out (SO) and end with a shift-in (SI) character. When this check box is selected, the SO and SI characters are removed from the data when it is received from the host application, and the SO and SI characters are added to the data when it is sent to the host application. In the length of the PIC G, it is not necessary to include the two bytes for the SO and SI characters because the TI run-time environment applies them. The possible values are: - True - False (default) |
| String Delimiting | Return value string delimiting. The possible values are: - Space-Padded. Tells the TI run-time environment that the mainframe representation of the string is delimited by padding the string definition with space characters. For example, if the mainframe's COBOL definition is PIC X(10) but only three characters are in the string, the mainframe expects seven trailing spaces. Therefore, selecting this option tells the TI run-time environment to convert strings being sent to the mainframe to change the string's NULL termination character to the appropriate number of trailing spaces before sending it to the mainframe. For example, if the string is defined on the mainframe as PIC X(10), TI will send a string of ABC followed by seven trailing spaces. Selecting this option also tells the TI run-time environment to convert the output string being returned from the mainframe to the TI Automation server by converting the string's trailing spaces to a single null termination character. (default) - Null-terminated. Tells the TI run-time environment that the mainframe representation of the string is delimited by a null character (EBCDIC 0x00). Selecting this option tells the TI run-time environment to add a single null character to the end of a string if there is room for the byte before sending a string to the mainframe, and it tells the TI run-time environment to stop at the first null character encountered when receiving a string from the mainframe. Therefore, by selecting this option, you are telling TI to retain trailing spaces in output strings coming from the mainframe because TI will not convert the trailing spaces to a single NULL terminator. For more information, see Padding Mainframe Character Strings with Spaces. |
Design Properties
| Use this | To do this |
|---|---|
| Data Type | The possible values are: - Void - Boolean - Byte - Date - Currency - Decimal - Integer - Long - Double - Single - String - User-defined type - Recordset - (none) (default) |
| Name | Name of the parameter. The name can be a maximum of 250 Unicode characters. |
| Parameter Direction | The possible values are: - In - Out - In / Out (default) |
Recordset Properties
| Use this | To do this |
|---|---|
| Include Actual Size | Default option indicating that the host program will not include or expect any information that indicates the actual number of rows (recordsets) or elements (arrays) being sent or received. The possible values are: - True - False (default) |
| Maximum Occurrence | Maximum row occurrence. Indicates the maximum number of rows to be sent to or received from the host. Equivalent to the OCCURS n TIMES keyword on a COBOL group item. |
| Occurs Depending On | Parameter recordset occurs depending on. Equivalent to variable-length tables in COBOL. Indicates that a numeric data item preceding the table (recordset or array in Automation) indicates the actual number of rows or elements being sent or received. Use the drop-down list to select which numeric data item specifies this value. For CICS Link, the recordset or array and the associated length specifier must be in/out. The data in the buffer that follows a variable length table immediately follows the last data item in the table regardless of the maximum size specified for the table. For arrays with multiple dimensions, it can only be used for the outermost loop (COBOL) or rightmost dimension (Visual C++ or Visual Basic). |
| Unbounded | Indicates the recordset is unbounded. Indicates that any number of rows can be sent to or received from the host. You would select this option when the rows being sent or received are from a database and the maximum number of rows is not known. The possible values are: - True - False (default) |
Caution
The properties of a component are not intended to be set or changed programmatically. Setting or changing the properties programmatically might cause the component to function incorrectly.
See Also
How to Pad Mainframe Character Strings with Spaces
Parameter Name Node (.NET)
Properties (TI Project)