IFileDocument.ReplaceAllRegExp Method

Automation:

ulong ReplaceAllRegExp ( [in] String RegExp, [in] uint SubExpression, [in] enum RegExpFlags reFlags, [in] byte pTo, [in] uint size_to, [in] ulong StartFrom, [in] ulong Size) ;

Native (C++):

HRESULT ReplaceAllRegExp ( [in] BSTR RegExp, [in] unsigned long SubExpression, [in] enum RegExpFlags reFlags, [in] unsigned char * pTo, [in] unsigned long size_to, [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. SubExpression The number of sub-match to search for. 0 means the entire expression. reFlags Flags that change the behavior of the function. May be one or more of the following values:

Flag	Value	Description
RegExpTypeANSI	0x00000000	Treat the given range as a stream of single-byte characters. May not be used with RegExpTypeUNICODE flag.
RegExpTypeUNICODE	0x00000001	Treat the given range as a stream of 16-bit unicode characters. May not be used with RegExpTypeANSI
RegExpIgnoreCase	0x00000002	True to ignore case and false to match case.

pToPointer to a replace pattern.size_toReplace pattern size.StartFrom A start offset of the range. Must be a multiple of 2 if RegExpTypeUNICODE flag is specified. Size Range's size. Must be a multiply of 2 if RegExpTypeUNICODE flag is specified. 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 pattern. Complexity: varying.

This method is obsolete. Use the IFileDocument.ReplaceAllRegExp2 instead.

< PreviousTopNext >