IFDIALN (HLI function) - Revision history

JDamon: /* Syntax */

2017-01-27T18:37:39Z

Syntax

← Older revision		Revision as of 18:37, 27 January 2017
Line 41:		Line 41:
	<tr>		<tr>
	<td>[SSNX:]CHAN</td>		<td>[SSNX:]CHAN</td>
	<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name ([[CRIOCHNL parameter]]) for a particular service program. Specify the name as an eight-character string.		<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name (the value of the [[CRIOCHNL parameter]]) for a particular service program. Specify the name as an eight-character string.

	The four-character, secondary subsystem name, SSNX, is optional. If present, the colon is a required delimiter. You can use it when you want to override the default value stored in IGCLM244. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings\|Subsystem names, channel names, and IODEV settings]] for defaults.		The four-character, secondary subsystem name, SSNX, is optional. If present, the colon is a required delimiter. You can use it when you want to override the default value stored in IGCLM244. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings\|Subsystem names, channel names, and IODEV settings]] for defaults.

JDamon: A little more tidy up on SSNX:CHAN

2017-01-27T18:27:35Z

A little more tidy up on SSNX:CHAN

← Older revision		Revision as of 18:27, 27 January 2017
Line 12:		Line 12:

	==Syntax==		==Syntax==
	<p class="syntax">IFDIALN\|IFDILN(RETCODE,LANG_IND,[~~SSN~~:]CHAN,BUFFER,IO_LEN)</p>		<p class="syntax">IFDIALN\|IFDILN(RETCODE,LANG_IND,[SSNX:]CHAN,BUFFER,IO_LEN)</p>
	<dl>		<dl>
	<dt>Compile-only form</dt>		<dt>Compile-only form</dt>
Line 40:		Line 40:
	</tr>		</tr>
	<tr>		<tr>
	<td>[~~SSN~~:]CHAN</td>		<td>[SSNX:]CHAN</td>
	<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name (CRIOCHNL) for a particular service program. Specify the name as an eight-character string. ~~Optionally~~, ~~the~~ secondary subsystem name ~~(SSN)~~ can ~~be specified~~ to override the default value stored in IGCLM244. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings\|Subsystem names, channel names, and IODEV settings]] for ~~the default channel names~~.		<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name ([[CRIOCHNL parameter]]) for a particular service program. Specify the name as an eight-character string.

			The four-character, secondary subsystem name, SSNX, is optional. If present, the colon is a required delimiter. You can use it when you want to override the default value stored in IGCLM244. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings\|Subsystem names, channel names, and IODEV settings]] for defaults.
	<p class="note"><b>Note:</b> Do <i>not</i> append a semicolon.</p>		<p class="note"><b>Note:</b> Do <i>not</i> append a semicolon.</p>
	<p>If the host language is PL/1, pass the address of the string using a based variable that overlays the original parameter.</p>		<p>If the host language is PL/1, pass the address of the string using a based variable that overlays the original parameter.</p>

JDamon: Added optional SSN to channel name argument.

2017-01-27T16:03:46Z

Added optional SSN to channel name argument.

← Older revision		Revision as of 16:03, 27 January 2017
Line 12:		Line 12:

	==Syntax==		==Syntax==
	<p class="syntax">IFDIALN\|IFDILN(RETCODE,LANG_IND,CHAN,BUFFER,IO_LEN)</p>		<p class="syntax">IFDIALN\|IFDILN(RETCODE,LANG_IND,[SSN:]CHAN,BUFFER,IO_LEN)</p>
	<dl>		<dl>
	<dt>Compile-only form</dt>		<dt>Compile-only form</dt>
Line 40:		Line 40:
	</tr>		</tr>
	<tr>		<tr>
	<td>CHAN</td>		<td>[SSN:]CHAN</td>
	<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name for a particular service program. Specify the name as an eight-character string. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings\|Subsystem names, channel names, and IODEV settings]] for the default channel names.		<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name (CRIOCHNL) for a particular service program. Specify the name as an eight-character string. Optionally, the secondary subsystem name (SSN) can be specified to override the default value stored in IGCLM244. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings\|Subsystem names, channel names, and IODEV settings]] for the default channel names.
	<p class="note"><b>Note:</b> Do <i>not</i> append a semicolon.</p>		<p class="note"><b>Note:</b> Do <i>not</i> append a semicolon.</p>
	<p>If the host language is PL/1, pass the address of the string using a based variable that overlays the original parameter.</p>		<p>If the host language is PL/1, pass the address of the string using a based variable that overlays the original parameter.</p>

ELowell at 22:11, 12 July 2016

2016-07-12T22:11:30Z

← Older revision		Revision as of 22:11, 12 July 2016
Line 1:		Line 1:
	The conventions used on this page are described in [[HLI: Function ~~call list~~#Function call notation conventions\|Function call notation conventions]].		The conventions used on this page are described in [[HLI: Function summary#Function call notation conventions\|Function call notation conventions]].

	==Summary==		==Summary==

ELowell at 21:15, 11 July 2016

2016-07-11T21:15:34Z

← Older revision		Revision as of 21:15, 11 July 2016
Line 1:		Line 1:
			The conventions used on this page are described in [[HLI: Function call list#Function call notation conventions\|Function call notation conventions]].

	==Summary==		==Summary==

ELowell: Created page with " ==Summary==

Description

The IFDIALN call (DIAL) starts an IFDIAL thread that establishes a direct connection to the Model 204 SOUL facility using a specifie..."

2016-07-06T20:35:31Z

Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFDIALN call (DIAL) starts an IFDIAL thread that establishes a direct connection to the Model 204 SOUL facility using a specifie..."

New page

==Summary==
<dl>
<dt>Description</dt>
<dd>The IFDIALN call (DIAL) starts an IFDIAL thread that establishes a direct connection to the Model 204 SOUL facility using a specified Host Language Interface/Model 204 service program. The connection is made through the specified channel name (in IFAM2).</dd>
<dt>Thread type</dt>
<dd>IFDIAL</dd>
<dt>IFCALL function number</dt>
<dd>7</dd>
</dl>

==Syntax==
IFDIALN|IFDILN(RETCODE,LANG_IND,CHAN,BUFFER,IO_LEN)
<dl>
<dt>Compile-only form</dt>
<dd>Not available<dd>
<dt>Execute-only form</dt>
<dd>Not available</dd>
</dl>

Specify the parameters in the syntax order shown above. 
<table>
<tr class="head">
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>RETCODE</td>
<td>[O,i,r] The Model 204 return code is the required first parameter. The code is a binary integer value.</td>
</tr>
<tr>
<td>LANG_IND</td>
<td>[I,i,r] The language indicator is a required input parameter that establishes the calling sequence convention to be used corresponding to the host language. The indicator specifies the format of parameters that are passed in subsequent calls. Specify one of the following integer values:
1 =PL/1 F-level, and BAL languages 
2 =COBOL, FORTRAN, and BAL languages
3 =PL/1 with +Optimizer/Checkout compilers, VS/FORTRAN, and BAL languages
Note: Any convention can be specified for use with the BAL language, and the BAL programmer must adhere to the convention that is specified when coding parameters.
</td>
</tr>
<tr>
<td>CHAN</td>
<td>[I,c,r] The channel name is a required input parameter that specifies the CRAM, or IUCV/ VMCF communications channel name for a particular service program. Specify the name as an eight-character string. See [[HLI: Job requirements#Subsystem names, channel names, and IODEV settings|Subsystem names, channel names, and IODEV settings]] for the default channel names.
Note: Do not append a semicolon.
If the host language is PL/1, pass the address of the string using a based variable that overlays the original parameter.
</td>
</tr>
<tr>
<td>BUFFER</td>
<td>[O,i,o] The buffer size is an optional output parameter that specifies the size of the CRAM buffer which is the maximum buffer length for I/O to Model 204. Model 204 returns the size of the buffer as an integer value.
BUFFER is required if IO_LEN is specified. 
</td>
</tr>
<tr>
<td>IO_LEN</td>
<td>[I,i,o] The I/O length is an optional input parameter that specifies the default length for I/O to Model 204. This is the length that is used if a length parameter is not specified in an IFREAD or IFWRITE call. See the LINE_LEN parameter for [[IFREAD (HLI function)|IFREAD]].
</td>
</tr>
</table>

==Usage notes==

Use the IFDIALN call to establish an IFDIAL connection using a specific Host Language Interface/Model 204 service program. IFDIALN performs the same basic function as IFDIAL. The IFDIALN call includes a parameter which is not available with IFDIAL that is used to specify the communications channel name for the service program.

Note: When an IFDIALN call is made with a language indicator of 1 or 3, Model 204 expects the channel name to be a string and not a PL/1 dope vector. 

For more information about IFAM2, CRAM, and the Host Language Interface/Model 204 service program, see [[HLI: Job requirements]] and [[HLI: IFAM2 CICS processing]]. 

==Completion return code (RETCODE)==

If the IFDIALN call is unsuccessful, Model 204 returns one of the following error codes:
<table>
<tr class="head">
<th>Code</th>
<th>Error condition</th>
</tr>
<tr>
<td>80</td>
<td>No current thread. (Action: Call IFSETUP.)</td>
</tr>
<tr>
<td>90</td>
<td>An IFDIAL connection already exists for this application program. The attempt to establish more than one simultaneous connection for this application is ignored.</td>
</tr>
<tr>
<td>101</td>
<td>Invalid module load. (Action: Check STEPLIB for correct release.)</td>
</tr>
<tr>
<td>500</td>
<td>Invalid function called.</td>
</tr>
<tr>
<td>800</td>
<td>All Model 204 IFDIAL connections are busy. (Action: Make sure the proper number of IODEV 29 init statements were included in the HLI Model 204 service program.)</td>
</tr>
<tr>
<td>1001</td>
<td>HLI Model 204 service program is not up, the HLI is halted or drained, or no host language threads were defined in Model 204. (This might indicate that the IFAM4 load module was link-edited without the REUS option.)
</td>
</tr>
<tr>
<td>1003</td>
<td>Not enough memory for CRAM.</td>
</tr>
</table>

==Coding examples==
===COBOL example===
WORKING-STORAGE SECTION.
01 CALL-ARGS.
05 RETCODE PIC 9(5) COMP SYNC.
05 COBOL-IND PIC 9(5) VALUE 2.
05 CHAN-NAME PIC X(8) VALUE "M204CHNB".
.
.
.
PROCEDURE DIVISION.
OPEN INPUT...
CALL "IFDIALN" USING RETCODE, COBOL-IND, CHAN-NAME.
.
.
.

===Assembler example===
.
.
.
CALL IFDIALN,(RETCODE,LANGID,CHAN0,CRAMSIZE),VL
.
.
.
RETCODE DC F'0'
LANGID DC F'2'
CHAN0 DC C'USR204C0'
CRAMSIZE DC F'0'
END 

[[Category: HLI functions]]