Interface IStdRegExpClass
RD-VBAL RegExp Module
public interface IStdRegExpClass
Remarks
This module from VBScript.RegExp.5.5 was folded into the Standard Library, but not to a corresponding MS-VBAL section.
Methods
Execute(VBRuntimeReference)
Executes the current regex match configuration against the provided source string.
RuntimeSemanticsEvaluationResult Execute(VBRuntimeReference sourceString)
Parameters
sourceStringVBRuntimeReferenceThe input string to match against the configured pattern.
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.
IStdRegExpClass__getGlobal()
Gets a flag indicating whether the regex returns after the first match (false) or not (true).
RuntimeSemanticsEvaluationResult IStdRegExpClass__getGlobal()
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.
IStdRegExpClass__getIgnoreCase()
Gets or sets a flag indicating whether the regex evaluates case-insensitive (true) or case-sensitive (false) matches.
RuntimeSemanticsEvaluationResult IStdRegExpClass__getIgnoreCase()
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.
IStdRegExpClass__getMultiline()
Gets a flag indicating whether ^ and $ denote the start/end of the input (false) or of a single line (true) of it.
RuntimeSemanticsEvaluationResult IStdRegExpClass__getMultiline()
Returns
IStdRegExpClass__getPattern()
Gets the Regular Expression pattern string for this instance.
RuntimeSemanticsEvaluationResult IStdRegExpClass__getPattern()
Returns
IStdRegExpClass__setGlobal(VBRuntimeBooleanValue)
Sets a flag indicating whether the regex returns after the first match (false) or not (true).
RuntimeSemanticsEvaluationResult IStdRegExpClass__setGlobal(VBRuntimeBooleanValue value)
Parameters
valueVBRuntimeBooleanValue
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.
IStdRegExpClass__setIgnoreCase(VBRuntimeBooleanValue)
Sets a flag indicating whether the regex evaluates case-insensitive (true) or case-sensitive (false) matches.
RuntimeSemanticsEvaluationResult IStdRegExpClass__setIgnoreCase(VBRuntimeBooleanValue value)
Parameters
valueVBRuntimeBooleanValue
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.
IStdRegExpClass__setMultiline(VBRuntimeBooleanValue)
Sets a flag indicating whether ^ and $ denote the start/end of the input (false) or of a single line (true) of it.
RuntimeSemanticsEvaluationResult IStdRegExpClass__setMultiline(VBRuntimeBooleanValue value)
Parameters
valueVBRuntimeBooleanValue
Returns
IStdRegExpClass__setPattern(VBRuntimeReference)
Sets the Regular Expression pattern string for this instance.
RuntimeSemanticsEvaluationResult IStdRegExpClass__setPattern(VBRuntimeReference value)
Parameters
valueVBRuntimeReference
Returns
Replace(VBRuntimeReference, VBRuntimeVariantValue)
Replaces regex matches in the provided source string with the specified replacement value.
RuntimeSemanticsEvaluationResult Replace(VBRuntimeReference sourceString, VBRuntimeVariantValue replaceVar)
Parameters
sourceStringVBRuntimeReferenceThe input string to replace matched content from.
replaceVarVBRuntimeVariantValueThe replacement value for any pattern matches.
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.
Test(VBRuntimeReference)
Tests whether the specified source string matches the currently configured Pattern for this instance.
RuntimeSemanticsEvaluationResult Test(VBRuntimeReference sourceString)
Parameters
sourceStringVBRuntimeReferenceThe input string to test against the configured pattern.
Returns
- RuntimeSemanticsEvaluationResult
A RuntimeSemanticsEvaluationResult object encapsulating the result of the successful operation, or the error metadata otherwise.