TapeTrack Documentation

Because there is more to tape management than you ever realized

User Tools

Site Tools

Trace:
engine:import:addstring

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
engine:import:addstring [2020/03/04 23:24] – [Syntax] Scott Cunliffeengine:import:addstring [2025/01/21 22:07] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== AddString ====== ====== AddString ======
  
-Add a special string such as an exclusion or header string.+Add a special String such as an Exclusion or Header String.
  
 ===== Phase ===== ===== Phase =====
Line 9: Line 9:
 ''AddString(type, offset, filter);'' ''AddString(type, offset, filter);''
  
-//string type;//\\ 
-//integer offset;//\\ 
-//string filter;//\\ 
 ^ Variable ^ Type ^ Description ^ Min Length ^ Max Length ^ Min Value ^ Max Value ^ ^ Variable ^ Type ^ Description ^ Min Length ^ Max Length ^ Min Value ^ Max Value ^
-|type| String | The special string type of one of the following: \\  +|type| String | The special string type from the below Type Values table |1|10|
-  - **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. +
-|1|10|+
 |offset| Integer | The zero based offset within the record at which the filter should be applied.|1|10|-214748364 |2147483647| |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| |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 ===== ===== Example =====
  
-**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**\\ +Define a header (ANSI page break) with 7 records, skip records not starting with an Integer and terminate processing at the first blank record. 
-|AddString(HEADER, 0, "1*");| + 
-|SetHeaderCount(7);| +<code> 
-|AddString(EXCLUSION, 0, "!([0-9]*");| +AddString(HEADER, 0, "1*"); 
-|AddString(TERMINATE, 0, "                   *");|+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}} {{tag> import_engine sync_engine}}
  
engine/import/addstring.1583364266.txt.gz · Last modified: 2025/01/21 22:07 (external edit)