#INCLUDESTR Details

Example: Job Notes, Tool Notes, Step Notes, etc.

The parameters for this CGT word are:



Except for JOS(note field tag) and Line Length, all of the parameters are strings. They can either be CGT # variables or literal strings. If a literal string, the string must be quoted. Example: 
Literal Strings:
#INCLUDESTR("<<",">>","(",")",JOS_STR(job_note),80)

Using Variables:

@DECLARE
#STR #delstart
#STR #delend
#STR #comstart
#STR #comend
#STR #jtag
@

@user section
#EVAL(#delstart=<<)
#EVAL(#delend=>>)
#EVAL(#comstart=()
#EVAL(#comend=\)) // note the backslash which causes the CG to treat the next character (the right parenthesis) as a literal
#EVAL(#jtag=JOS_STR(job_note))
#INCLUDESTR(#delstart,#delend,#comstart,#comend,#jtag,80)
When generating code both of the above commands will output the same content. They will both search for the Start Marker string in your Job Notes memo field. If the Start Marker is found, it will search for the End Marker. If both are found, the text between the two markers will be output to your NC code file. Each line of text in the note field will be output to a new line in your NC file.

Each output line will be pre- and post-fixed with the supplied Comment Start and Comment End strings.

In the above example, the line length is 80 characters. If a line in your multi-line text field is greater than 80 characters, the line will be split at the 80 character marker. Anything after the split point will be output on a new line.

Not all text in your notes field may be suitable for output to your NC file; for example, your notes field could include Code Generator related variable assignments. There is very little reason to output these to your code file, this is why the function only outputs text between the Start and End marker strings.

In the above example the Start Marker is "<<" and the End Marker is ">>". An example note field content might look like: 
This line is not output
<<This line is output
As is this line>>
This line is not output
The text added to your NC file would look like: 
(This line is output)
(As is this line)

This CGT word only outputs text between the two provided Start/End markers. If the referenced note field does not include these markers, nothing will be output. When used, both markers must be used - you cannot have just a Start marker or just an End marker.

The Start and End Marker strings must be different, you cannot use the same delimiter for both. You cannot use white space or the # character in either. Using an empty string ("") in either (or both) of the Start and End Marker parameters has special meaning. When an empty string is used as the Start Marker parameter, it means from the beginning of the line. If used as the End Marker it means to the end of the line. Using the empty strings as the Start of Line and End of Line markers you can output everything in your note field, without having to add any special marker strings in your text.

You can have multiple, separated output blocks in your Note field. They will all be output. Example: 
<<This is the first block.>>
This line is not output.
<<This line is output, it is the second block>>
When coded the following is output: 
(This is the first block.)
(This line is output, it is the second block)
The Comment Start and End strings can include any valid character. Additionally, they can be empty strings ("quot;) so that nothing is prefixed or postfixed onto the output lines.

The Line Length field sets the maximum length of each output line. If the line of text in the Note field is longer than the provided line length value, the line is split at the maximum line length and any remaining characters are output on the next line (or next multiple-lines, depending upon the actual length of the note field string and the Line Length value provided). If the Line Length value is 0 or Less, then the line is not truncated and will be output without modification.

The #INCLUDESTR() CGT word is very similar to the existing #INCLUDE() word and many of the same restrictions apply to both. The CGT words should be on a line by themselves, they do not keep current output state so using "<" and ">quot; brackets has no meaning.

The CGT word does not work within Conditional test brackets. For example:

#IF(some test)<#INCLUDESTR("^^","~~","(",")",JOS_STR(job_note),80)>

If you want to conditionally output the contents of a note field using this CGT word, have the IF test change the Start and End marker characters.

Example: 
#IF(some test)<#EVAL(#delstart=<<)
#EVAL(#delend=>>)>
#INCLUDESTR(#delstart,#delend,"(",")",JOS_STR(job_note),80)
@