Name
pitem:Split -- split item
Synopsis
item = pitem:Split(split_index, split_offset)
Function
Modifies the item to cover only the text after split_index, and returns a new item that covers the text before split_index that used to be in the original item.

You can think of split_index as the length of the returned item. split_index may not be 0, and it may not be greater than or equal to the length of the item (that is, there must be at least one byte assigned to each item, you can't create a zero-length item). split_offset is the length of the first item in chars, and must be provided because the text used to generate the item isn't available, so this function can't count the char length of the split items itself.

This function returns new item representing text before split_index, which should be freed with pitem:Free().

Inputs
split_index
byte index of position to split item, relative to the start of the item
split_offset
number of chars between start of the item and split_index
Results
item
new item representing text before split_index

Show TOC