You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.5 Help

Replaces one or all instances of a substring with another substring. To include the multiline? Boolean input, right-click the function and select Regular Expression.

Details  Example

	multiline? specifies whether to match the ^ and $ symbols to the beginning and end of a line, respectively, or to the beginning and end of the whole string, respectively. If FALSE (default), the function matches the symbols to the beginning and end of a single line. You can wire this terminal only in Regular Expression mode.
	ignore case? specifies whether the string search is case sensitive. If FALSE (default), the string search is case sensitive.
	replace all? specifies whether the function should replace all occurrences of the search string or only the first occurrence. If FALSE (default), the function replaces only the first occurrence.
	input string is the input string the function searches.
	search string is the string you want to search for and replace. If search string is an empty string and replace all? is TRUE, the function inserts replace string before and after each character in input string.
	replace string replaces the string in search string. The default is an empty string.
	offset determines the number of characters into input string at which the function starts searching for search string.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	result string contains the input string with one or all occurrences of search string replaced with replace string. If replace string is empty, result string contains input string with search string deleted.
	number of replacements returns the number of times LabVIEW replaced search string.
	offset past replacement indicates the offset in result string of the character immediately following where the last match and replacement occurred. If replace all? is FALSE, the next match, if any, is after this point. If the function does not find search string, offset past replacement is –1.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Search and Replace String Details

This function searches string for occurrences of search string, starting at offset. The function replaces the first occurrence with replace string. If replace all? is TRUE, the function replaces all the occurrences. If you want to perform a case-insensitive search or search for more complex patterns, configure the function for advanced regular expression searches, use the Search and Replace Pattern VI, or the Match Regular Expression function.

Right-click the Search and Replace String function and select Regular Expression from the shortcut menu to configure the function for advanced regular expression searches and partial match substitution in the replacement string.

Example

Refer to the Search String and Replace VI in the labview\examples\general\strings.llb for an example of using the Search and Replace String function.