pub.io:skip

pub.io:skip

WmPublic. Skips over and discards the specified number of bytes or characters from the input stream or a reader object.

Input Parameters

stream	java.io.InputStream Optional. The InputStream. Note: You can use either stream or reader to specify the input object. If both stream and reader input parameters are provided, then the stream and reader object data will be skipped.
reader	java.io.Reader Optional. The reader object.
length	String The number of bytes or characters to skip.

Output Parameters

stream	java.io.InputStream. Conditional. The InputStream. Returned only if the input parameter is stream.
reader	java.io.Reader. Conditional. The reader object. Returned only if the input parameter is reader.
bytesSkipped	String. Conditional. The actual number of bytes that were skipped. Returned only if the input parameter is stream.
charactersSkipped	String. Conditional. The number of characters that were skipped. Returned only if the input parameter is reader.

Usage Notes

Thepub.io:skip service uses the uses the Java methodInputStream.skip, which might skip some smaller number of bytes, possibly zero (0). This happens due to conditions such as reaching the end of file before n bytes have been skipped. For more information about the InputStream.skip method, see the Java documentation on the InputStream class.

Either of the optional input parameters, stream or reader, is required.

If both stream and reader input parameters are specified and if an exception occurs during the stream object usage, then the operations are not performed on the reader object also.