Parameter Loop Expansion Tokens

Parameter Loop Token

Description

<CUSTOM_PARAMETER_token>

Custom parameter loop expansion tokens allow you to insert content defined by custom expansion tokens defined in a method catalog extensions file. Note that custom expansion token names are not not case sensitive, always being converted to uppercase for comparison, but that the associated values are, being inserted exactly as defined in the extensions file.

<PARAMETER_ATTRIBUTE>

Inserts a Synergy {xfParameter} attribute for the current parameter.

NOTE: The behavior of this token can be altered by the PARAMDEFSTR tweak.

<PARAMETER_COERCE_TYPE>

Inserts the coercion type associated with the current parameter.

Possible values:  None, Boolean, Byte, DateTime, DateTimeNullable, Decimal, DecimalNullable, Double, Float, Int, Long, Sbyte, Short, Uint, Ulong, Ushort

<PARAMETER_COLECTION_TYPE>

Inserts the collection type of a collection parameter.

Possible values:  None, Array, MemoryHandle, ArrayList

<PARAMETER_COMMENT>

The the parameter has an associated comment then this token inserts that text, otherwise nothing is inserted.

<PARAMETER_CSTYPE_XF>

Inserts the C# data type that xfNetLink .NET would use to represent the parameter.

<PARAMETER_DATA_TABLE>

Inserts a boolean value indicating whether the current parameter is exposed to .NET clients as a DataTable.

Possible values:  True, False

<PARAMETER_DATE_FORMAT>

Inserts a string indicating the date format associated with the current date parameter.

Possible values:  None, YYYYMMDD, YYMMDD, YYJJJ, YYYYJJJ, HHMM, HHMMSS, YYYYMMDDHHMISS, YYYYMMDDHHMISSUUUUUU

<PARAMETER_DEFINITION>

Inserts the parameter data type definition of the current parameter.

Possible values:  a<size>, d<size>, d<size>.<precision>, i<size>, [*]a<size>, [*]d<size>, [*]d<size>.<precision>, [*]i<size>, string, D_HANDLE, ENUM_NAME, STRUCTURE_NAME
 

NOTE: The behavior of this token can be altered by the PARAMDEFSTR tweak. When specified, structure names will be CamelCased and prefixed with "str". So structure CUSTOMER_ADDRESS will be represented as strCustomerAddress.

<PARAMETER_DEFINITION_NOARRAY>

Inserts the parameter data type definition of the current parameter, but without any array declaration for array fields.

Possible values:  a<size>, d<size>, d<size>.<precision>, i<size>, string, D_HANDLE, ENUM_NAME, STRUCTURE_NAME
 

NOTE: The behavior of this token can be altered by the PARAMDEFSTR tweak. When specified, structure names will be CamelCased and prefixed with "str". So structure CUSTOMER_ADDRESS will be represented as strCustomerAddress.

<PARAMETER_DIRECTION>

Inserts the data flow direction associated with the current parameter.

Possible values: IN, OUT, INOUT

Alternates:  <parameter_direction>

<PARAMETER_DIRECTION_PAD>

Inserts the data flow direction associated with the current parameter. The string output will be right-padded with spaces to a length of 5 characters.

Possible values:  IN, OUT, INOUT

Alternate forms:  <parameter_direction>

<PARAMETER_ENUM>

If the type of the parameter is defined by an ENUM then this token inserts the name of that ENUM, otherwise nothing is inserted.

<PARAMETER_MAXVALUE>

If the parameter type is decimal, implied decimal or integer then this token inserts the maximum positive value that can be passed to the parameter. There is no ability to define that parameters can't receive negative numbers. Nothing is inserted for other parameter types.

<PARAMETER_MINVALUE>

If the parameter type is decimal, implied decimal or integer then this token inserts the minimum negative value that can be passed to the parameter. There is no ability to define that parameters can't receive negative numbers. Nothing is inserted for other parameter types.

<PARAMETER_NAME>

Inserts the name of the current parameter.

Alternates:  <parameter_name>, <Parameter_Name>, <Parameter_name>, <ParameterName>, <parameterName>

<PARAMETER_NUMBER>

Inserts the 1-based number of the current parameter.

<PARAMETER_PASS_BY>

Inserts a string indicating the parameter passing mechanism of the current parameter.

Possible values:  DESCRIPTOR, REFERENCE, VALUE

<PARAMETER_PRECISION>

If the parameter type is implied decimal then this token inserts the precision (number of digits after the decimal place) of the parameter, otherwise nothing is inserted.

<PARAMETER_REQUIRED>

Inserts a string indicating whether the current parameter is required or optional.

Possible values:  OPTIONAL, REQUIRED

Alternates: <parameter_required>

<PARAMETER_SAMPLE_DATA>

Inserts sample date for the parameter. This token is intended to be used for the generation of examples in documentation or API references.

NOTE: This token only currently works with basic field types alpha, decimal, implied decimal, integer and boolean. For other field types nothing is inserted.

Possible Values:  "Z", 9, 9.9, ""

<PARAMETER_SAMPLE_DATA_ESCAPED>

Inserts sample date for the parameter with any double quotes escaped with a backward slash (\). This token is intended to be used for the generation of examples in documentation or API references and is particularly useful when generating data into YAML files.

NOTE: This token only currently works with basic field types alpha, decimal, implied decimal, integer and boolean. For other field types nothing is inserted.

Possible Values:  \"Z\", 9, 9.9, \"\"

<PARAMETER_SIZE>

Inserts the size of the current parameter, if appropriate, or by a blank string if not.

<PARAMETER_STRUCTURE>

Inserts the name of the STRUCTURE that defines the current parameters type. If the return type is not a structure then a blank string is returned.

Alternates:  <parameter_structure>, <Parameter_Structure>, <Parameter_structure>, <ParameterStructure>, <parameterStructure>

NOTE: The behavior of this token can be altered by the PARAMDEFSTR tweak.

<PARAMETER_STRUCTURE_NOPLURAL>

Inserts the name of the STRUCTURE that defines the current parameters type. If the name of the structure does ends with an "S" then it is removed. If the return type is not a structure then a blank string is returned.

Alternates:  <parameter_structure_noplural>, <Parameter_Structure_Noplural>, <Parameter_structure_noplural>, <ParameterStructureNoplural>, <parameterStructureNoplural>

NOTE: The behavior of this token can be altered by the PARAMDEFSTR tweak.

<PARAMETER_STRUCTURE_PLURAL>

Inserts the name of the STRUCTURE that defines the current parameters type. If the name of the structure does not end with an "S" then one is added. If the return type is not a structure then a blank string is returned.

Alternates:  <parameter_structure_plural>, <Parameter_Structure_Plural>, <Parameter_structure_plural>, <ParameterStructurePlural>, <parameterStructurePlural>,

NOTE: The behavior of this token can be altered by the PARAMDEFSTR tweak.

<PARAMETER_TSTYPE>

Inserts the TypeScript compatible type of the current parameter.

Possible values:  boolean, boolean[], Date, Date[], Nullable<Date>, Nullable<Date>[], number, number[], string, string[], structureName, structureName[]

Structure names will be represented in singular form and in Pascal case.

<PARAMETER_TYPE>

Inserts the type of the current parameter.

Possible values:  Alpha, BinaryHandle, Decimal, ImpliedDecimal, Enumeration, Handle, Integer, String, Structure