Difference between revisions of "Retrieve Object Description (QUSROBJD)"

From MidrangeWiki
Jump to: navigation, search
(Created page with "Category:API Category:RPG_Prototypes == Summary == The following is an RPG/LE fully free-form prototype for the IBM QUSROBJD API to retrieve the description for a spe...")
 
(Summary)
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
The following is an RPG/LE fully free-form prototype for the IBM QUSROBJD API to retrieve the description for a specified object.  The calling process must have at least *USE authority for the object.
 
The following is an RPG/LE fully free-form prototype for the IBM QUSROBJD API to retrieve the description for a specified object.  The calling process must have at least *USE authority for the object.
 +
 +
For more information on this API, visit [https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_72/apis/qusrobjd.htm Retrieve Object Description (QUSROBJD) API] (right-click to open link in a new tab).
 +
 +
By [[User:DaveLClarkI|Dave Clark]]
  
 
== Prototype for the QUSROBJD API ==
 
== Prototype for the QUSROBJD API ==
 
<pre>
 
<pre>
 
//******************************************************************************
 
//******************************************************************************
// IBM API to Retrieve a Subsystem Description
+
// IBM API to Retrieve an Object's Description (if authorized to object)
// https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_72/apis/qwdrsbsd.htm
+
// https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_72/apis/qusrobjd.htm
 
//******************************************************************************
 
//******************************************************************************
/include qsysinc/qrpglesrc,qwdrsbsd         // QWDRSBSD API data structures
+
/include qsysinc/qrpglesrc,qusrobjd         // QUSROBJD API data structures
dcl-pr IBMAPI_RtvSbsDesc         extpgm('QWDRSBSD');
+
dcl-pr IBMAPI_RtvObjDesc         extpgm('QUSROBJD');
   SbsDscInfo            likeds(QWDI0200)    options(*varsize);
+
   ObjDesc              likeds(QUSD0400)    options(*varsize);
   SbsDscInfL            int(10)  const;
+
   ObjDscL              int(10)  const;
   SbsDscFmt            char(8)  const;
+
   ObjDFmt              char(8)  const;
   SbsDscName            char(20)  dim(1)   const options(*varsize);
+
   ObjName              char(20)  const;
   SbsDscErrC            likeds(ApiErrC)    options(*varsize);
+
  ObjType              char(10) const;
// optional parm group
+
// optional parm group 1
   SbsDscCntN            int(10)   const    options(*nopass);
+
   ObjErrC              likeds(ApiErrC)    options(*nopass:*varsize);
 +
// optional parm group 2
 +
   ObjAspC              likeds(QUSRASPC)   options(*nopass);
 
end-pr;
 
end-pr;
 
</pre>
 
</pre>
  
 
== References ==
 
== References ==
* [[ApiErrC — API Error Code]]
+
* [[API Error Code Structure (ApiErrC)]]

Latest revision as of 11:57, 17 December 2018

Summary

The following is an RPG/LE fully free-form prototype for the IBM QUSROBJD API to retrieve the description for a specified object. The calling process must have at least *USE authority for the object.

For more information on this API, visit Retrieve Object Description (QUSROBJD) API (right-click to open link in a new tab).

By Dave Clark

Prototype for the QUSROBJD API

//******************************************************************************
// IBM API to Retrieve an Object's Description (if authorized to object)
// https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_72/apis/qusrobjd.htm
//******************************************************************************
/include qsysinc/qrpglesrc,qusrobjd         // QUSROBJD API data structures
dcl-pr IBMAPI_RtvObjDesc          extpgm('QUSROBJD');
  ObjDesc               likeds(QUSD0400)    options(*varsize);
  ObjDscL               int(10)   const;
  ObjDFmt               char(8)   const;
  ObjName               char(20)  const;
  ObjType               char(10)  const;
// optional parm group 1
  ObjErrC               likeds(ApiErrC)     options(*nopass:*varsize);
// optional parm group 2
  ObjAspC               likeds(QUSRASPC)    options(*nopass);
end-pr;

References