Difference between revisions of "Snippets"
From MidrangeWiki
m (%TIME) |
m (fix ref) |
||
| Line 347: | Line 347: | ||
=== RPG SYSTEM NAME=== | === RPG SYSTEM NAME=== | ||
| + | |||
| + | ref: [[http://archive.midrange.com/rpg400-l/200506/msg00326.html]] | ||
| + | |||
D RtvSysName PR 8A | D RtvSysName PR 8A | ||
| Line 353: | Line 356: | ||
C EVAL MyName = RtvSysName() | C EVAL MyName = RtvSysName() | ||
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | *++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
| − | * Retrieve System Name | + | * Retrieve System Name |
| − | |||
P RtvSysName B Export | P RtvSysName B Export | ||
D RtvSysName PI 8A | D RtvSysName PI 8A | ||
| Line 368: | Line 370: | ||
D DS ds | D DS ds | ||
D Attrs 10I 0 | D Attrs 10I 0 | ||
| − | D Offset 10I 0 | + | D Offset 10I 0 |
| − | D | + | D AtrNam 10a |
| − | + | D DtaTyp 1a | |
| + | D InfSts 1a | ||
| + | D AtrLen 10I 0 | ||
| + | D RtnSystem 8A | ||
| + | * Call API to get system name | ||
C callp QWCRNETA(DS: %size(DS): 1: 'SYSNAME': EC) | C callp QWCRNETA(DS: %size(DS): 1: 'SYSNAME': EC) | ||
| − | C return | + | C return RtnSystem |
P E | P E | ||
[[#top]] | [[#top]] | ||
| + | |||
| + | |||
==External links== | ==External links== | ||
Revision as of 04:05, 31 October 2008
Contents
SNIPPETS
A snippet is a sort of code template or skeleton that allows you to quickly set up a commonly used code fragment like a subprocedure definition (in ILE RPG).
This differs from code templates because the code template is invoked by the code completion facility Ctrl+Space.
Code completion with templates requires you to start keying the 'trigger' (in RPG, usually the operation code.)
With snippets, you can have Lpex include anything at all, with no trigger needed aside from the double click on the selected snippet.
Snippets View
original post [1]
To open a snippets view:
- Window → Show view → Other → Basic → Snippets
Create a Snippets Category
original post [2]
- You only need to create a Category once, conceptually its like CRTSRCPF.
- Create as many Categories as you wish.
- -Right-click in the Snippets view and select Customize...
- -Click the New button and create a New Category
- -Click the New button and create a New Item
- -Click on the snippet and then click the New button that is adjacent to the Variables list
- -Enter your snippet and use the Insert Variable Placeholder button to add the variable
alternatively use the copy, right click process below, its easier.
Use snippets for RPGLE, CLLE, DSPF and PRTF source members.
Snippets RPG
original post [3]
You can use the snippets to insert stuff into your program.
To create your own RPG snippets,
- you can open the view in RSE or iSeries Editing perspective,
- select your source,
- then Right Click / Paste in the snippets view, into your Previously created Category.
It will then create a new template.
To use the snippet;
- Open a source member for editing.
- Place the cursor where you want the code.
- Go to the Snippets view, to the Category where the snippet is.
- Double click on the snippet and it appears in the source
original post [4]
Another method is to create a Snippet.
- Open the Snippets view.
- Create a new 'Drawer' for your snippets.
- Copy some source.
- Right-click in your snippet drawer, paste.
- This will bring up the snippet creation wizard.
Long Procedure Name
original post [5]
How do I get the PR to stay at the same column position, irrespective of what name I use for the procedure ?
Use:
D ${Procedure}...
PR
Otherwise the procedure name has to always be 12 characters in length. With the elipsis (...) it can be up to 60 odd characters in length.
Examples
Subprocedure skeleton:
Subprocedure skeleton
* ${proc_comment}
p ${proc_name} b
d ${proc_name} pi 10i 0
d ${parm_name} 1a
d rc 10i 0 inz
c/free
return rc;
/end-free
p e
EXEC SQL
ref [6]
C/EXEC SQL
C+ SELECT * FROM mylib/myfile
C/END-EXEC
free
exec sql select * from mylib/myfile;
Open Cursor and Fetch Mainline
ref [7]
H ActGrp(*CALLER)
H DftActGrp(*NO)
D OpenCursor PR n
D FetchCursor PR n
D CloseCursor PR n
D MyLib s 10a
D MyFile s 10a
/free
*inlr=*on;
if not OpenCursor();
// perform error routine to alert the troops
// ...
Else;
Dow FetchCursor();
// putting the fetchcursor on the do loop allows the user of
// iter, and thus iter will not perform an infinite loop
// normal processing here...
EndDo;
CloseCursor();
EndIf;
return;
/end-free
Open Cursor Procedure
ref [8]
P OpenCursor B
D OpenCursor PI like(ReturnVar)
D ReturnVar s n
// The immediately following /EXEC SQL is SQL's version of RPG's H Spec
// It is never executed. Just used at compile time.
C/EXEC SQL
C+ Set Option
C+ Naming = *Sys,
C+ Commit = *None,
C+ UsrPrf = *User,
C+ DynUsrPrf = *User,
C+ Datfmt = *iso,
C+ CloSqlCsr = *EndMod
C/END-EXEC
C/EXEC SQL
C+ Declare C1 cursor for
C+ Select System_Table_Schema as library,
C+ System_Table_Name as file
C+ from qsys2/systables
C/END-EXEC
C/EXEC SQL
C+ Open C1
C/END-EXEC
/free
Select;
When SqlStt='00000';
return *on;
Other;
return *off;
EndSl;
/end-free
P OpenCursor E
Fetch Cursor Procedure
ref [9]
P FetchCursor B
D FetchCursor PI like(ReturnVar)
D ReturnVar s n
C/EXEC SQL
C+ Fetch C1 into :MyLib, :MyFile
C/END-EXEC
/free
Select;
When sqlstt='00000';
// row was received, normal
ReturnVar=*on;
When sqlstt='02000';
// same as %eof, sooner or later this is normal
ReturnVar=*off;
Other;
// alert the troops!
ReturnVar=*off;
EndSl;
return ReturnVar;
/end-free
P FetchCursor E
Close Cursor Procedure
ref [10]
P CloseCursor B
D CloseCursor PI like(ReturnVar)
D ReturnVar s n
C/EXEC SQL
C+ Close C1
C/END-EXEC
/free
Select;
When sqlstt='00000';
// cursor was closed, normal
ReturnVar=*on;
Other;
// alert the troops!
ReturnVar=*off;
EndSl;
return ReturnVar;
/end-free
P CloseCursor E
Exporting and importing snippets
ref [[11]]
Snippets can be transferred to another PC by the process of exporting and importing.
You export on the PC you want to copy the snippets from, and import on the PC you want to copy them to.
Exporting
- In the Snippets view right click and select Customize
- Select your custom snippet category
- Select Export (top of the category list, left side)
- See the 'Save as...' dialogue box, remember the file name you chose!
- Copy/FTP/email that XML file to the target PC
Importing
- Get a snippets XML file some place where it's available to WDSC
- In the Snippets view right click and select Customize
- Select your custom snippet category
- Select Import (top of the category list, left side)
- See the 'Open...' dialogue box.
- Select the XML file to import
Snippets XML structure
<?xml version="1.0" encoding="UTF-16"?>
<snippets>
<category filters="*" id="category_1185380127750" initial_state="0" label="RPG" largeicon="" smallicon="">
<description/>
<item category="category_1185380127750" class="" editorclass="" id="item_1207666311828" label="subprocedure" largeicon="" smallicon="">
<description><![CDATA[Subprocedure skeleton]]></description>
<content><![CDATA[
* ${proc_comment}
p ${proc_name} b
d ${proc_name} pi 10i 0
d ${parm_name} 1a
d rc 10i 0 inz
c/free
return rc;
/end-free
p e]]></content>
<variable default="Description of procedure" id="name_3" name="proc_comment">
<description><![CDATA[Description]]></description>
</variable>
<variable default="new_parm" id="name_2" name="parm_name">
<description><![CDATA[Parameter name]]></description>
</variable>
<variable default="new_proc" id="name_1" name="proc_name">
<description><![CDATA[Procedure name]]></description>
</variable>
</item>
</category>
</snippets>
DayOfWeek snippet
ref [[12]]
* // Procedure: DayOfWeek //
* // Purpose: Determine the day of week for a particular date //
* // Parameters: //
* // I: dt -- date //
*
* // Returns: //
* // 0..6 -- 0=Sunday, 1=Monday, 2=Tuesday, etc. //
* // Notes: //
* // January 5, 1800 is a Sunday. This procedure only works for //
* // dates later than 1800-01-05. //
* //\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\//
P DayOfWeek b
P
D DayOfWeek pi 10i 0
D
D dt d value datfmt(*iso)
/free
return %rem (%diff (dt: d'1800-01-05': *days): 7);
/end-free
P DayOfWeek e
System Date snippet
ref [[13]]
Time also works Return %INT(%CHAR(%TIME():*ISO0)) set PI to 6S 0.
* // Procedure: SysDate //
* // Purpose: Gets the system date YYYYMMDD format 8S 0 //
* // Parameters: //
* // Returns: //
* // int -- date in YYYYMMDD fmt //
* //\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\//
P SysDate B
P
D SysDate PI 8S 0
D
/free
Return %INT(%CHAR(%DATE():*ISO0));
/end-free
P SysDate E
CLLE Subroutine
ref [[14]]
Sample code V5R4
START: PGM
SAVLIB LIB( PVCPROD) DEV(TAP01) ENDOPT(*LEAVE) /* Daily library backup */
MONMSG MSGID(PVC0001) EXEC(DO)
CALLSUBR BADLIBSAVE
ENDDO
RETURN
SUBR BADLIBSAVE
/* test */
ENDSUBR
ENDPGM
RPG SYSTEM NAME
ref: [[15]]
D RtvSysName PR 8A
D MyName S 10A
C eval *inlr = *on
C EVAL MyName = RtvSysName()
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* Retrieve System Name
P RtvSysName B Export
D RtvSysName PI 8A
D QWCRNETA PR ExtPgm('QWCRNETA')
D RcvVar 32766A OPTIONS(*VARSIZE)
D RcvVarLen 10I 0 const
D NbrNetAtr 10I 0 const
D AttrNames 10A const
D ErrorCode 256A
D* Error code structure
D EC DS 256
D* Receiver variable for QWCRNETA
D DS ds
D Attrs 10I 0
D Offset 10I 0
D AtrNam 10a
D DtaTyp 1a
D InfSts 1a
D AtrLen 10I 0
D RtnSystem 8A
* Call API to get system name
C callp QWCRNETA(DS: %size(DS): 1: 'SYSNAME': EC)
C return RtnSystem
P E
External links
The official WDSC web page [16]
The WDSC Developer blog [17]
WDSC tags on del.ici.ous [18]
