28.11.2012 Views

IBM Tivoli NetView for z/OS Programming: Pipes - IBM notice

IBM Tivoli NetView for z/OS Programming: Pipes - IBM notice

IBM Tivoli NetView for z/OS Programming: Pipes - IBM notice

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Usage Notes<br />

The default stage separator character is X'4F'. On American and English 3270<br />

displays, X'4F' is represented as a vertical bar (|). In other countries or on<br />

some workstations, X'4F' can be displayed as an exclamation mark or a split<br />

vertical bar.<br />

v For the PIPE command and its stages, a delimiter can be any character except<br />

alphanumeric characters, parentheses, blanks, nulls, and national characters (@,<br />

#, and $). The maximum length <strong>for</strong> a delimited string is 255 characters. Multiple<br />

delimited strings must be separated by blanks. In the <strong>for</strong>mats shown, the<br />

delimiter is a /.<br />

Ensure that delimited strings do not contain:<br />

– The delimiter character in use<br />

– The stage separator (unless escaped)<br />

– The escape character (unless escaped)<br />

– The end character (unless escaped)<br />

v The presence of the escape character has no effect on characters that have special<br />

meaning to individual stages. For example, do not use the escape character<br />

within a delimited string in an attempt to include the delimiter character in the<br />

string.<br />

v If running DBCS, be careful of what STAGESEP character is used. The <strong>NetView</strong><br />

program determines the hexadecimal equivalent of the STAGESEP character and<br />

then scans the string until it finds it again. The scan does not determine if the<br />

string is part of a DBCS character. The next occurrence of the string ends the<br />

stage command. See “PIPE VAR and PIPE $VAR ” on page 251 <strong>for</strong> more<br />

in<strong>for</strong>mation.<br />

v See the individual stages <strong>for</strong> other usage notes that apply.<br />

Return Codes<br />

Pipeline Stages and Syntax<br />

Return Code Meaning<br />

0 The pipeline ran successfully.<br />

8 An option field error occurred.<br />

12 A PIPE syntax error occurred, or a stage separator character was<br />

used improperly.<br />

16 A stage specification error occurred.<br />

20 A storage failure occurred during PIPE interpretation.<br />

24 The pipeline is clogged. A deadlock occurred during pipeline<br />

processing.<br />

For in<strong>for</strong>mation on debugging clogged pipeline conditions see<br />

Chapter 8, “Debugging <strong>NetView</strong> Pipelines,” on page 345.<br />

-1 An unrecoverable error occurred during processing, it was possibly<br />

a looping condition.<br />

-5 A RESET condition occurred.<br />

Chapter 2. Pipeline Stages and Syntax 23

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!