====== AddString ======

Add a special String such as an Exclusion or Header String.

===== Phase =====

This instruction is used by the TapeTrack Import Engine.
===== Syntax =====
''AddString(type, offset, filter);''

^ Variable ^ Type ^ Description ^ Min Length ^ Max Length ^ Min Value ^ Max Value ^
|type| String | The special string type from the below Type Values table |1|10|
|offset| Integer | The zero based offset within the record at which the filter should be applied.|1|10|-214748364 |2147483647|
|filter| String | A filter value for comparison with the processed string.|1|256|


^Type Values ^^
^Value ^ Description ^
|HEADER |A string that represents the first record of a heading section.|
|EXCLUSION |A string that represents the a record that should be excluded from all further processing (skipped).|
|START| A string that represents when processing should start. If there is no start string specified processing will start at the first record.|
|END|A string that represents when processing should temporarily stop. Processing will recommence at the next START record.|
|TERMINATE|A string that represents when processing should permanently stop. No processing will be done past this point, even if a START record is encountered.|

===== Example =====

Define a header (ANSI page break) with 7 records, skip records not starting with an Integer and terminate processing at the first blank record.

<code>
AddString(HEADER, 0, "1*");
SetHeaderCount(7);
AddString(EXCLUSION, 0, "!([0-9]*");
AddString(TERMINATE, 0, "                   *");
</code>

===== See Also =====

[[engine:import|Import Engine Functions]] \\
[[cli:sync_fields|Sync Engine Fields]] \\
[[cli:tmss10sync|TMSS10Sync]]

{{tag> import_engine sync_engine}}