www.krengeltech.com

RXS Naming Conventions

From Wiki

User Guide

The sample applications contain comments and coding examples to help the RPG Programmer understand how to use the RXS APIs. If you know the naming approach to variables, functions and other things, you will better understand the code snippets and be empowered to adapt them to your own applications.

A lower-case ‘g’ prefixes global variables. For example:


     D gError          ds                  likeds(RXS_Error)
     D gXml            s          65535a   varying


A lower-case ‘p’ prefixes parameters of ILE modules. For example:


     P allHandler      b
     D allHandler      pi
     D  pType                              value like(RXS_Type)
     D  pXPath                             value like(RXS_XPath)
     D  pData                              value like(RXS_XmlData)
     D  pDataLen                           value like(RXS_Length)


The characters “RXS_” prefix all RPG-XML Suite subprocedures. For example:


     RXS_initTplEng(RXS_STDOUT: *omit: *omit: *omit: *omit: *on);
     RXS_loadTpl('rxs3.tpl');
     RXS_wrtSection('HTTP_HEAD');


Copy books used in /copy statements have a CP extension (i.e. RXSCP).

Members that contain RPG module code have a suffix of FN (FN stands for functions).

Members that contain the binder language for service program creation have a suffix of SV for “service”.