Back Forward Parse-Byte-Pos method

Methods and instructions by function

Use the Parse-Byte-Pos method in the Steps tab of a Parse Structured rule (Rule-Parse-Structured rule type) to extract a fixed number of bytes from the input Java byte stream into a clipboard property value.

NoteYou cannot use this method in an activity. You cannot use this method if the associated input is a character stream rather than a byte stream.

Parameters

This method has three parameters:

Parameter

Description

Offset Enter a non-negative number of bytes to move the selection point from current byte position before copying data.
Length Enter a number of bytes to select.
TargetProperty Optional. Identify a Single Value target property to hold the resulting value.

Results

The system reads the specified number of bytes from the input byte stream. It converts these bytes into a string using the character encoding specified in the associated ParseState object. (This is ordinarily the default character encoding for the UNIX or Windows platform hosting Process Commander.)

See More About Parse Structured rules.

If the TargetProperty field is not blank, it sets the result as the value of the property identified. If the target property is not present on the clipboard, it is added.

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Related topics About Parse Structured rules

zzzMethods and instructions by function