Free cookie consent management tool by TermsFeed searchb() Function
searchb() Function

Function

searchb( search_text, within_text, start_num )

Searches the text for a particular substring, returning the positional index of the first byte of the first match.

See also: search(), find()

Parameters

Keyword Type Description

search_text

Text

The text that will be searched for.

within_text

Text

The text to be searched.

start_num

Number

The index of the within_text value from which to start searching. 1 by default.

Returns

Number

Usage considerations

Using the search_text parameter

The search_text parameter supports ? as a wildcard character.

Using the within_text parameter

The first byte of the entire within_text value has an index of 1.

Examples

Searching for a substring within a string

1
searchb("to", "boston")

Returns 4.

Searching a string with multiple bytes per character

1
searchb("tt", "café latte")

Returns 9. The "é" character counts as 2 bytes.

Searching with a start index

1
searchb("o", "boston", 4)

Returns 5. The function starts searching the string at byte index 4.

Lists

Searching multiple strings at once

1
searchb({ "t", "i" }, { "boston", "paris" })

Returns { 4, 4 }.

Searching with multiple start indices

1
searchb("o", "boston", { 1, 3 })

Returns { 2, 5 }. The search is repeated at each start index in the list.

Searching multiple strings with wildcards

1
searchb("s??n", { "boston", "paris" })

Returns { 3, 0 }.

Edge cases

Empty list parameters

1
searchb({}, "boston")

Returns {}.

Empty string start_num

1
searchb("o", "boston", "")

Returns 0. The function always returns 0 when given an empty string start_num.

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Compatible

Can be used to create a custom record field that only evaluates at sync time.

Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Compatible
Process Events Compatible
Open in Github Built: Fri, Dec 08, 2023 (09:12:34 PM)

searchb() Function

FEEDBACK