friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apiref_5.4.0.1/ileRetrieveILEC.htm

370 lines
19 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="Example in ILE C: Retrieve exit point and exit program information" />
<meta name="abstract" content="This program retrieves exit point and exit program information. After retrieving the exit point information, the program resolves to each associated exit program and calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable." />
<meta name="description" content="This program retrieves exit point and exit program information. After retrieving the exit point information, the program resolves to each associated exit program and calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable." />
<meta name="DC.Relation" scheme="URI" content="ileScenario.htm" />
<meta name="DC.Relation" scheme="URI" content="conContinuation.htm" />
<meta name="DC.Relation" scheme="URI" content="conContinuation.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="ileRetrieveILEC" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Example in ILE C: Retrieve exit point and exit program information</title>
</head>
<body id="ileRetrieveILEC"><a name="ileRetrieveILEC"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Example in ILE C: Retrieve exit point and exit program information</h1>
<div><p>This program retrieves exit point and exit program information.
After retrieving the exit point information, the program resolves to each
associated exit program and calls each exit program. The Retrieve Exit Information
API returns a continuation handle when it has more information to return than
what fits in the receiver variable.</p>
<div class="section"><div class="note"><span class="notetitle">Note:</span> Read the <a href="codedisclaimer.htm">Code license and disclaimer information</a> for important
legal information.</div>
<pre>/********************************************************************/
/* PROGRAM: Retrieve Exit Point and Exit Program Information */
/* */
/* LANGUAGE: ILE C */
/* */
/* DESCRIPTION: This program retrieves exit point and exit */
/* program information. After retrieving the */
/* exit point information, the program resolves to */
/* each associated exit program and calls each exit */
/* program. */
/* */
/* APIs USED: QusRetrieveExitInformation - Retrieve Exit */
/* Information */
/* */
/********************************************************************/
/********************************************************************/
/* Includes */
/********************************************************************/
#include &lt;stdio.h&gt;
#include &lt;signal.h&gt;
#include &lt;string.h&gt;
#include &lt;stdlib.h&gt;
#include &lt;except.h&gt;
#include &lt;qusrgfa2.h&gt;
#include &lt;qusec.h&gt;
#include &lt;qmhchgem.h&gt;
#include &lt;miptrnam.h&gt;
#include &lt;qliept.h&gt;
/********************************************************************/
/* Prototypes */
/********************************************************************/
typedef void Pgm_OS(void *arg,...);
#pragma linkage(Pgm_OS,OS)
/********************************************************************/
/* Structures */
/********************************************************************/
typedef struct { /* Error code */
Qus_EC_t ec_fields;
char exception_data[100];
} error_code_struct;
/********************************************************************/
/* FUNCTION NAME: RSLVSP_PGM_HDLR */
/* */
/* FUNCTION : This function handles all exceptions that */
/* may occur while resolving to the exit */
/* program. */
/* */
/* INPUT: Interrupt handler information */
/* */
/* OUTPUT: NONE */
/* */
/********************************************************************/
void RSLVSP_PGM_HDLR(_INTRPT_Hndlr_Parms_T *errmsg)
{
error_code_struct Error_Code;
/******************************************************************/
/* Set the rsl_ok indicator to not valid. */
/******************************************************************/
int *rsl_ok = (int *)(errmsg&gt;Com_Area);
*rsl_ok = 0;
/******************************************************************/
/* Let message handler know that the program handled the message */
/* and to remove it from the job log. */
/******************************************************************/
Error_Code.ec_fields.Bytes_Provided=0;
QMHCHGEM(&amp;(errmsg&gt;Target),
0,
(char *)&amp;errmsg&gt;Msg_Ref_Key,
"*REMOVE ",
"",
0,
&amp;Error_Code);
}
/********************************************************************/
/* FUNCTION NAME: Call_Exit_Program */
/* */
/* FUNCTION : This function calls the exit programs that */
/* were retrieved from the registration facility */
/* repository. */
/* */
/* INPUT: Information retrieved */
/* */
/* OUTPUT: NONE */
/* */
/********************************************************************/
void Call_Exit_Program(char *rcv_var)
{
int num_exit_pgms,
i;
char exit_pgm_name[10],
exit_pgm_lib[10],
info_for_exit_pgm[10],
*rcv_ptr;
volatile int rsl_ok;
Pgm_OS *exit_pgm_ptr;
/******************************************************************/
/* Save the number of exit programs returned and set the pointer */
/* to point to the first exit program entry. */
/******************************************************************/
rcv_ptr=rcv_var;
num_exit_pgms=((Qus_EXTI0200_t *)rcv_ptr)&gt;Number_Programs_Returned;
rcv_ptr += ((Qus_EXTI0200_t *)rcv_ptr)&gt;Offset_Program_Entry;
rsl_ok=1;
for (i=0; i&lt;num_exit_pgms; i++)
{
memcpy(exit_pgm_name,
((Qus_EXTI0200_Entry_t *)rcv_ptr)&gt;Program_Name,10);
memcpy(exit_pgm_lib,
((Qus_EXTI0200_Entry_t *)rcv_ptr)&gt;Program_Library,10);
/****************************************************************/
/* Resolve to the exit program. If an error occurs on the */
/* resolve operation to the library, the rsl_ok indicator is */
/* set to failed in the RSL_PGM_HDLR exception handler. */
/* The rslvsp MI instruction signals all errors to this */
/* program; therefore, enable the exception handler to capture */
/* any errors that may occur. */
/****************************************************************/
#pragma exception_handler (RSLVSP_PGM_HDLR,rsl_ok,0,_C2_MH_ESCAPE)
exit_pgm_ptr=((Pgm_OS *)rslvsp(_Program,
exit_pgm_name,
exit_pgm_lib,
_AUTH_POINTER));
#pragma disable_handler
/****************************************************************/
/* If the resolve operation is successful, call the exit */
/* program. If not, move on to the next exit program. */
/****************************************************************/
if (rsl_ok)
{
exit_pgm_ptr(info_for_exit_pgm);
}
/****************************************************************/
/* Set the receiver variable to point to the next exit program */
/* that is returned. */
/****************************************************************/
rsl_ok=1;
rcv_ptr=rcv_var +
((Qus_EXTI0200_Entry_t *)rcv_ptr)&gt;Offset_Next_Entry;
}
}
/********************************************************************/
/* */
/* main */
/* */
/********************************************************************/
void main()
{
int sel_criteria=0,
len_rcv_variable=3500,
exit_pgm_num=-1;
char continuation_hdl[16],
rcv_variable[3500],
*rcv_ptr;
error_code_struct error_code;
/******************************************************************/
/* Retrieve the exit point information first. If the current */
/* number of exit programs is not zero, retrieve the exit */
/* programs. It is not necessary to call for the exit point */
/* information to determine if the exit point has any exit */
/* programs. It is done here for illustration purposes only. */
/* You can make one call to the API for the exit program */
/* information and check the number of exit program entries */
/* returned field to see if there are any exit programs to call. */
/******************************************************************/
/******************************************************************/
/* Initialize the error code to inform the API that all */
/* exceptions should be returned through the error code parameter.*/
/******************************************************************/
error_code.ec_fields.Bytes_Provided=sizeof(error_code_struct);
/******************************************************************/
/* Blank out the continuation handle to let the API know that this*/
/* is a first attempt at the retrieve operation. */
/******************************************************************/
memset(continuation_hdl,' ',16);
/******************************************************************/
/* Call the API to retrieve the exit point information. */
/******************************************************************/
QusRetrieveExitInformation(continuation_hdl,
&amp;rcv_variable,
len_rcv_variable,
"EXTI0100",
"EXAMPLE_EXIT_POINT ",
"EXMP0100",
exit_pgm_num,
&amp;sel_criteria,
&amp;error_code);
/******************************************************************/
/* If an exception occurs, the API returns the exception in the */
/* error code parameter. The bytes available field is set to */
/* zero if no exception occurs and nonzero if an exception does */
/* occur. */
/******************************************************************/
if (error_code.ec_fields.Bytes_Available != 0)
{
printf("ATTEMPT TO RETRIEVE INFORMATION FAILED WITH EXCEPTION: %.7s",
error_code.ec_fields.Exception_Id);
exit(1);
}
/******************************************************************/
/* If the call to retrieve exit point information is successful, */
/* check to see if there are any exit programs to call. */
/******************************************************************/
rcv_ptr=rcv_variable;
rcv_ptr += ((Qus_EXTI0100_t *)rcv_ptr)-&gt;Offset_Exit_Point_Entry;
if (((Qus_EXTI0100_Entry_t *)rcv_ptr)-&gt;Number_Exit_Programs != 0)
{
/*****************************************************************/
/* Blank out the continuation handle to let the API know that */
/* this is a first attempt at the retrieve operation. */
/*****************************************************************/
memset(continuation_hdl,' ',16);
/*****************************************************************/
/* Call the API to retrieve the exit program information. */
/*****************************************************************/
QusRetrieveExitInformation(continuation_hdl,
&amp;rcv_variable,
len_rcv_variable,
"EXTI0200",
"EXAMPLE_EXIT_POINT ",
"EXMP0100",
exit_pgm_num,
&amp;sel_criteria,
&amp;error_code);
/*****************************************************************/
/* Verify that the call to the API is successful. */
/*****************************************************************/
if (error_code.ec_fields.Bytes_Available != 0)
{
printf("ATTEMPT TO RETRIEVE EXIT PROGRAMS FAILED WITH EXCEPTION:\
%.7s", error_code.ec_fields.Exception_Id);
exit(1);
}
/*****************************************************************/
/* If the call is successful, call the exit programs. */
/*****************************************************************/
Call_Exit_Program(rcv_variable);
/*****************************************************************/
/* If the continuation handle field in the receiver variable is */
/* not set to blanks, the API has more information to return */
/* than what could fit in the receiver variable. */
/*****************************************************************/
rcv_ptr=rcv_variable;
while (memcmp(((Qus_EXTI0200_t *)rcv_ptr)-&gt;Continue_Handle,
" ",16)!=0)
{
memcpy(continuation_hdl,
((Qus_EXTI0200_t *)rcv_ptr)&gt;Continue_Handle,16);
/***************************************************************/
/* Call the API to retrieve the exit program information. */
/***************************************************************/
QusRetrieveExitInformation(continuation_hdl,
&amp;rcv_variable,
len_rcv_variable,
"EXTI0200",
"EXAMPLE_EXIT_POINT ",
"EXMP0100",
exit_pgm_num,
&amp;sel_criteria,
&amp;error_code);
/***************************************************************/
/* Verify that the call to the API is successful. */
/***************************************************************/
if (error_code.ec_fields.Bytes_Available != 0)
{
printf("RETRIEVE EXIT PROGRAMS FAILED WITH EXCEPTION: %.7s",
error_code.ec_fields.Exception_Id);
exit(1);
}
/***************************************************************/
/* If the call is successful, call the exit programs. */
/* The receiver variable offers enough room for a minimum of */
/* one exit program entry because the receiver variable was */
/* declared as 3500 bytes. Therefore, this example only */
/* checks the number of exit programs returned field. If the */
/* receiver variable were not large enough to hold at least */
/* one entry, the bytes available field would need to be */
/* checked as well as the number of exit programs returned */
/* field. If the number of exit programs returned field is */
/* set to zero and the bytes available field is greater than */
/* the bytes returned field, the API had at least one exit */
/* program entry to return but was unable to because the */
/* receiver variable was too small. */
/***************************************************************/
Call_Exit_Program(rcv_variable);
} /* While continuation handle not set to blanks */
} /* Number of exit programs not equal to zero */
} /* End program */</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ileScenario.htm" title="The example APIs in this section represent two general functions of APIs--change and retrieve.">Scenario: Integrated Language Environment (ILE) APIs</a></div>
</div>
<div class="reltasks"><strong>Related tasks</strong><br />
<div><a href="conContinuation.htm" title="Some APIs that return information offer a continuation handle.">Continuation handle</a></div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink