CMSFM5 — Set_FM_Header_5_Extension
|
Where
conversation_ID (character input) specifies the conversation identifier of the desired conversation.
FMH5_extension (character input) specifies the information beyond the base FMH-5. All of the extension data for the conversation must appear on a single CMSFM5 statement. Subsequent CMSFM5 statements for this conversation overwrite any extension information previously supplied.
The format is a character string from two to 255 characters long and must appear exactly as it would appear in an FMH-5.
FMH5_extension_length (numeric input) specifies the total length of the extension. The format is an integer value from two to 255. If an incorrect length is specified, the statement completes with a parameter check return code.
return_code (numeric output) specifies the result of the statement execution.
log_byte is a 1-byte string constant or a string expression that specifies a byte of user data to be associated with this CPI-C statement during logging. The log_byte remains active until another CPI-C statement is issued. Only the first character or first two hexadecimal digits of the string expression are used. The default log_byte is X'00'.
Function
The CMSFM5 statement provides FMH-5 extension data to WSim during a CPI-C simulation. The CMSFM5 statement is an extension to the CPI-C architecture. A program uses the CMSFM5 statement to provide additional information beyond the base FMH-5 that may be required for an Attach request. This additional information is called FMH-5 extension data, and can include security subfields, logical unit of work, conversation correlator, and PIP data.
For more information on the format of the base FMH-5, refer to VTAM Programming for LU 6.2. The CMSFM5 statement is used to supply all data that is required beyond the base FMH-5 (defined by the ISTFM5 DSECT). This data is specified by the FMH5_extension parameter. The format of this parameter is a character string from 2 to 255 bytes long. The extension data must be specified exactly as it would appear in an FMH-5. For example, if both access security information and a conversation correlator are required; specify the data defined by the FM5ASI DSECT, followed by the data defined by the FM5CVCOR DSECT. The FMH5_extension_length parameter must reflect the total length of the FMH-5 extension data. The format of this parameter is an integer from 2 to 255. If an incorrect length is specified by this parameter, or within the extension data, the CMSFM5 verb will complete with a parameter check return code.