Form object
Sets user-defined batch variables.
If a batch report layout containing user-defined variables is used when processing the form, you can use this method to set those user-defined variables.
The format is:
"<byte value representing variable name length><variable name><format type (X or N)><byte value representing the length of the variable’s value><value>..."
If you are setting new variables, you can use any name and format for your variable.
To set user variables already defined in a batch report layout file, you must specify the name and format of the variable as it is defined.
The batch report layout contains a user-defined variable called #MyCode with the format XXX. You want to set the value to ABC before the form is transferred. To do this, you use SetUserBundleInfo on a form-level event (such as FormComplete) as follows:
"{6}MyCodeX{3}ABC"
means that the character has the ASCII value 6. This byte is not a visible character. It represents the length of the variable name (MyCode, which contains 6 characters).
is the format of the variable that was defined and is a byte with a value of 3, which is the length (XXX).
is the value you are assigning to MyCode.
To set two or more user batch variables, add on to the string with the respective characters in the same format as the first part. Do not use any separator characters, null characters, etc. Example:
"{6}MyCodeX{3}ABC{6}MyVar3N{2}46"
This would set MyCode to ABC and MyVar3 to 46.
If the user-defined variables are included in the transaction description, then the values are transferred.
This is an advanced method that is probably best implemented in C++.