Differences

This shows you the differences between two versions of the page.

--- engine:import:addstring [2018/08/14 16:28] – [Syntax] dcumming
+++ engine:import:addstring [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== AddString ======
-Add a special string such as an exclusion or header string.
+Add a special String such as an Exclusion or Header String.
 ===== Phase =====
@@ Line 7: / Line 7: @@
 This instruction is used by the TapeTrack Import Engine.
 ===== Syntax =====
-AddString(type, offset, filter);
+''AddString(type, offset, filter);''
-//string type;//\\
+^ Variable ^ Type ^ Description ^ Min Length ^ Max Length ^ Min Value ^ Max Value ^
-//integer offset;//\\
+|type| String | The special string type from the below Type Values table |1|10|
-//string filter;//\\
+|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   The special string type of one of the following:
-  - **HEADER** A string that represents the first record of a heading section.|
+^Type Values ^^
-  - **EXCLUSION** A string that represents the a record that should be excluded from all further processing (skipped).|
+^Value ^ Description ^
-  - **START** A string that represents when processing should start. If there is no start string specified processing will start at the first record.|
+|HEADER |A string that represents the first record of a heading section.|
-  - **END** A string that represents when processing should temporarily stop. Processing will recommence at the next START record.|
+|EXCLUSION |A string that represents the a record that should be excluded from all further processing (skipped).|
-  - **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.|
+|START| A string that represents when processing should start. If there is no start string specified processing will start at the first record.|
-offset	The zero based offset within the record at which the filter should be applied.\\
+|END|A string that represents when processing should temporarily stop. Processing will recommence at the next START record.|
-filter	A filter value for comparison with the processed string.
+|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.|
-===== Examples =====
-Example A.22. AddString: Define a header (ANSI page break) with 7 records, skip records not starting with an integer and terminate processing at the first blank record
+===== 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}}