IFileDocument.ReplaceAllRegExpWithRegExp Method

Automation:

ulong ReplaceAllRegExpWithRegExp ( [in] String RegExp, [in] String ReplacePattern, [in] uint CodePage, [in] enum RegExpFlags reFlags, [in] ulong StartFrom, [in] ulong Size) ;

Native (C++):

HRESULT ReplaceAllRegExpWithRegExp ( [in] BSTR RegExp, [in] BSTR ReplacePattern, [in] unsigned long CodePage, [in] enum RegExpFlags reFlags, [in] unsigned __int64 StartFrom, [in] unsigned __int64 Size, [out, retval] unsigned __int64 * pReplaced) ;

Parameters

RegExp A string that contains a regular expression. A regular expression must by in ECMAScript syntax. ReplacePattern A string that contains a replace regular expression. CodePage Code page for both regular expression patterns encoding or CP_UNICODE (-5) for UTF-16. reFlags Flags that change the behavior of the function. May be one or more of the following values:

Flag	Value	Description
RegExpIgnoreCase	0x00000002	True to ignore case and false to match case.

StartFrom A start offset of the range. Must be a multiple of 2 if UTF-16 encoding is used. Size Range's size. Must be a multiply of 2 if UTF-16 encoding is used. pReplacedPointer to a variable to receive a number of occurrences.

Return Value

Automation:A number of occurrences.Native: S_OK or standard OLE error code.

Remarks

Finds and replaces all occurrences of regular expression matches with a given regular expression pattern. Complexity: varying.

< PreviousTopNext >