IFCCUR (HLI function) - Revision history

ELowell at 22:05, 12 July 2016

2016-07-12T22:05:31Z

← Older revision		Revision as of 22:05, 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:04, 11 July 2016

2016-07-11T21:04:41Z

← Older revision		Revision as of 21:04, 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 at 20:41, 5 July 2016

2016-07-05T20:41:46Z

← Older revision		Revision as of 20:41, 5 July 2016
Line 1:		Line 1:

	==Summary==		==Summary==
	~~===~~Description~~===~~		<dl>
	The IFCCUR call (CLOSE CURSOR) closes the named cursor on the current thread.		<dt>Description</dt>
			<dd>The IFCCUR call (CLOSE CURSOR) closes the named cursor on the current thread.</dd>
	~~===~~Thread type~~===~~		<dt>Thread type</dt>
	multiple cursor IFSTRT		<dd>multiple cursor IFSTRT</dd>
			<dt>IFCALL function number</dt>
	~~===~~IFCALL function number~~===~~		<dd>125</dd>
	125		</dl>

	==Syntax==		==Syntax==

	<p class="syntax">IFCCUR(RETCODE,CURSOR_NAME)</p>		<p class="syntax">IFCCUR(RETCODE,CURSOR_NAME)</p>
			<dl>
	~~===~~Compile-only form~~===~~		<dt>Compile-only form</dt>
	Not available		<dd>Not available</dd>
			<dt>Execute-only form</dt>
	~~===~~Execute-only form~~===~~		<dd>Not available</dd>
	Not available		</dl>

	<p>Specify the parameters in the syntax order shown above.</p>		<p>Specify the parameters in the syntax order shown above.</p>

ELowell: Created page with " ==Summary== ===Description=== The IFCCUR call (CLOSE CURSOR) closes the named cursor on the current thread. ===Thread type=== multiple cursor IFSTRT ===IFCALL function numb..."

2016-07-05T17:39:40Z

Created page with " ==Summary== ===Description=== The IFCCUR call (CLOSE CURSOR) closes the named cursor on the current thread. ===Thread type=== multiple cursor IFSTRT ===IFCALL function numb..."

New page

==Summary==
===Description===
The IFCCUR call (CLOSE CURSOR) closes the named cursor on the current thread.

===Thread type===
multiple cursor IFSTRT

===IFCALL function number===
125

==Syntax==

IFCCUR(RETCODE,CURSOR_NAME)

===Compile-only form===
Not available

===Execute-only form===
Not available

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>CURSOR_NAME</td>
<td>[I,s,r] Is a required input parameter that specifies the name of the cursor to be closed. This is a short character string (maximum 32 characters), the name previously assigned to the cursor in a corresponding IFOCUR call.

See CURSOR_NAME on [[IFOCUR (HLI function)|IFOCUR]] for a description of the cursor name for the IFOCUR call.
</td>
</tr>
</table>

==Usage notes==

Use the IFCCUR call to close a cursor that is open on a thread. The IFCCUR call indicates that processing against the cursor is complete. 

You can reference a cursor again after it has been closed by reopening it. For example, before referencing a closed cursor in a subsequent IFFTCH statement, reopen it by issuing an IFOCUR call.
Note: When you reopen a cursor, Model 204 locates the cursor one position before the first record or value in the found set.

The IFCCUR call provides companion functionality to the [[IFOCUR (HLI function)|IFOCUR]] in the host language multiple cursor environment.

==Coding example (COBOL)==
WORKING-STORAGE SECTION.
01 CALL-ARGS.
05 RETCODE PIC 9(5) COMP SYNC.
.
.
.
05 CURSOR-NAME PIC X(7) VALUE "CRFORD;".
.
.
.
PROCEDURE DIVISION.
.
.
.
CALL "IFCCUR" USING RETCODE, CURSOR-NAME.

Note: In the example, IFCCUR closes a cursor (named CRFORD) that was opened and named by a previous IFOCUR call (not shown). See the coding example for IFOCUR on [[IFOCUR (HLI function)|IFOCUR]]. An IFCCUR call can only be used to close a cursor that is open. 

[[Category: HLI functions]]