PAD stage v1.0

Pipelines v2.0

Purpose, Operands, Streams used, Usage notes, Examples, See also

Home

Syntax

 _Right_ _SPACE_
>>__PAD__|_______|__length__|_______|__________________________________________________><
 |_Left__| |_char__|

Purpose

Use the PAD stage to extend records with one or more specified characters or spaces. You can extend a record on the left or right. PAD reads records from its primary input stream; extends the records, and writes the resulting records to its primary output stream.

Operands

●	Right specifies that records are padded on the right. This is the default.
●	Left specifies that records are padded on the left.
●	length is an unsigned integer which specifies the length to which PAD is to extend records. If the length of a record is less than length, PAD extends the record with the number of characters needed to make the output record length characters in length. If the length of the record is greater than or equal to length, PAD copies the record unchanged to its primary output stream.
●	char is the character used to extend output records.

Streams used

The following streams are used by the PAD stage:

Stream	Action
Primary input stream	PAD reads records from its primary input stream.
Primary output stream	After extending the records read from its primary input stream, PAD writes the resulting records to its primary output stream.

Usage notes

1)	PAD does not delay the records.
2)	If the PAD stage discovers that its primary output stream is not connected, the PAD stage ends.
3)	PAD verifies that its secondary input and output streams are not connected and then begins execution.

Examples

Padding records

See also

Reference the following links for additional information:

CHOP, SPLIT, STRIP

History of change

None.