STR_STARTS_WITH

The STR_STARTS_WITH script function checks whether the beginning of a certain string complies with another string. You must specify the string that should be checked (String1) and the string that should be used for checking the required beginning (String2). This script function also supplies "Y" when String1 and String2 are identical.This comparison is case sensitive.

Syntax

STR_STARTS_WITH (String1, String2)

Parameters

  • STR_STARTS_WITH

    Checks whether a string starts with a certain other string

  • String1

    The string that should be checked

    Format: script literal or script variable

  • String2

    The string that is used for checking string1.

    Format: script literal or script variable

Return codes

  • Y

    String1 starts with string2
  • N

    String1 does not start with string2



Examples

The following example reads the object title and checks whether it starts with the term "Docu". If so, a corresponding message is written to the activation report.
 
:SET &VAR#GET_ATT(OBJECT_TITLE)

:SET &CHECK# = STR_STARTS_WITH(&VAR#,"Docu")

:IF &CHECK# EQ "Y"

P "Object title starts with 'Docu'"

:ENDIF

See also: