SETRIGHT - Extract right substring

SETRIGHT Extract right substring

Top Previous Next

Syntax:	SETRIGHT	[ variable ] = [ value ] [ cnt ] [ /options ]
Arguments:	[ variable ]	Variable to assign; if the variable does not previously exist it is created.
	[ value ]	Variable or string defining the value from which the substring is to be extracted.
	[ cnt ]	Variable, string, or numeric constant defining the length of the substring; this value must resolve to a numeric value less than or equal to the length of [ value ].
Options:	/split	Save the unextracted portion of the string back in [ value ].

This script command extracts the rightmost [ cnt ] characters from [ value ] and saves the result in [ variable ].

If the /split option is specified, the unextracted portion of [ value ] is assigned back to [ value ] replacing the original value.

Consider the following example.

;; assign a variable to a string

SET string = "this is a string"

;; extract the rightmost 6 characters

SETRIGHT substring = string 6

;; another example of syntax to extract the rightmost 6 characters

SETNUM len = 6

SETRIGHT substring = string len

The resulting substring variable contains the value "string". The original string variable is unchanged.

Consider the same example using the /split option to remove a 4 character extension from a file's name.

;; We start with a file name in standard DOS 8.3 format

SET filename = "ReadMe.txt"

;; extract the rightmost 4 characters

SETRIGHT extension = filename 4 /split

The resulting extension variable contains the value ".txt" and the remaining original "ReadMe" is stored in the filename variable. Use the SETEXTRACT command to parse filenames that have variable length extensions.

Related command(s): SETLEFT, SETMID, SETLEN, SETEXTRACT, SETSUBSTR, SET