Clarion Community Help

The following symbols are in alphabetical order:

The March 25, 2013 Clarion Sharp blog documented new Clarion 9 Template Symbols for the Procedure Parameters.

As part of the ongoing work and evolution of the Win32 AppGen, and based on numerous requests the following template symbols are now built-in (as opposed to defined at the template level):

%Parameters – single, dependent from %Procedure The full list of a procedure’s formal parameters separated by commas and enclosed in parentheses unless empty

%ProcedureParameterName – multi, dependent from %Procedure The list of names of all formal parameters as entered in %Parameters symbols; if missing then the name of that parameter as in %Prototype symbol is returned; if that is missing too, an AppGen generated name is returned

The Blog was incorrect stating %ProcedureParameterName was Multi, the correct symbol is %ProcedureParameters.

%ProcedureParameters (correction) – multi, dependent from %Procedure The list of names of all formal parameters as entered in %Parameters symbols; if missing then the name of that parameter as in %Prototype symbol is returned; if that is missing too, an AppGen generated name is returned

%ProcedureParameterName – single multi, dependent from %ProcedureParameters Names of parameter as entered in %Parameters symbols; if missing then the name of that parameter as in %Prototype symbol is returned; if that is missing too, an AppGen generated name is returned

%ProcedureParameterOrigName – single, dependent from %ProcedureParameters The name of the parameter as entered in the %Prototype symbol

%ProcedureParameterType – single, dependent from %ProcedureParameters The type of the parameter as entered in the %Prototype symbol (without the CONST keyword and square brackets for array types)

%ProcedureParameterDefault – single, dependent from %ProcedureParameters The default value of parameters as entered in the %Prototype symbol

%ProcedureParameterOmitted – single, dependent from %ProcedureParameters Returns %True if the parameter is declared as omittable in the %Prototype symbol

%ProcedureParameterByReference – single, dependent from %ProcedureParameters Returns %True if the parameter’s type is declared with leading * in the %Prototype symbol

%ProcedureParameterConstant – single, dependent from %ProcedureParameters Returns %True if the parameter’s type is declared with the CONST keyword in the %Prototype symbol

And a new built-in symbol has been introduced into C9:

%ProcedureParameterDIMs – single, dependent from %ProcedureParameters Returns the number of dimensions if the parameter’s type is declared as an array in the %Prototype symbol (1 for [] , 2 for [,] , etc.)

The updated Application Generator reads TXA files produced by earlier Clarion versions. TXA files produced by the C9 AppGen can’t be read by previous versions.

---

A template is available on GitHub to enumerate these new symbols as comments to see the exact values returned.

!------------Extension: ParamSymbolsTestC9 from ParamSymbolsTestC9tpl ------------
!---------------------------------------------------------------------------------
! %Prototype:   (<CONST *BYTE[] P1>, BYTE P2_Def=2, <BYTE P3_Omt>, *BYTE P4_Addr, *LONG[] A1, *SHORT[,] A2, ? U1, *? U2)
! %Parameters:  (<CONST *BYTE[] P1>,BYTE P2_Def,<BYTE P3_Omt>,*BYTE P4_Addr,*LONG[] A1,*SHORT[,] A2,? U1,*? U2) 
!----------------------------------------------------------------------------------
! #FOR(%ProcedureParameters)  is MULTI dependent on %Procedure
!----------------------------------------------------------------------------------
! Parameter # 1 - BYTE P1 
! %ProcedureParameters           = P1                    ! Name also, was hoping was entire parameter
! %ProcedureParameterName        = P1                    ! Name from Parameters
! %ProcedureParameterOrigName    = P1                    ! Name from Protoype
! %ProcedureParameterType        = BYTE                  ! TYPE w/o CONST * [] decoration &  UPPER
! %ProcedureParameterDefault     =                       ! Value if TYPE NAME=Default Value
! %ProcedureParameterOmitted     = 1                     ! %True (1) if <omitted>
! %ProcedureParameterByReference = 1                     ! %True (1) if *TYPE (by Address), no * then %False 
! %ProcedureParameterConstant    = 1                     ! %True (1) if CONST
! %ProcedureParameterDIMs        = 1                     ! TYPE[] Array 1=[] 2=[,] 3=[,,] ... 0=Not[]
!----------------------------------------------------------------------------------
! Parameter # 2 - BYTE P2_Def 
! %ProcedureParameters           = P2_Def                ! Name also, was hoping was entire parameter
! %ProcedureParameterName        = P2_Def                ! Name from Parameters
! %ProcedureParameterOrigName    = P2_Def                ! Name from Protoype
! %ProcedureParameterType        = BYTE                  ! TYPE w/o CONST * [] decoration &  UPPER
! %ProcedureParameterDefault     = 2                     ! Value if TYPE NAME=Default Value
! %ProcedureParameterOmitted     =                       ! %True (1) if <omitted>
! %ProcedureParameterByReference =                       ! %True (1) if *TYPE (by Address), no * then %False 
! %ProcedureParameterConstant    =                       ! %True (1) if CONST
! %ProcedureParameterDIMs        = 0                     ! TYPE[] Array 1=[] 2=[,] 3=[,,] ... 0=Not[]
!----------------------------------------------------------------------------------