Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

RegExpInit

DEPRECATED. Initializes the structure for processing matching operation with regular expressions.

Syntax

IppStatus ippsRegExpInit(const char* pPattern, const char* pOptions, IppRegExpState* pRegExpState, int* pErrOffset);

Include Files

ippch.h

Domain Dependencies

Headers: ippcore.h, ippvm.h, ipps.h

Libraries: ippcore.lib, ippvm.lib, ipps.lib

Parameters

pPattern

Pointer to the pattern of regular expression.

pOptions

Pointer to options for compiling and executing regular expressions (possible values i, s, m, x, g). It must be NULL if no options are required.

pRegExpState

Pointer to the structure containing internal form of a regular expression.

pErrOffset

Pointer to the offset in the pattern if compiling is break.

Description

NOTE:
This function is deprecated and will be removed in a future release. If you have concerns, open a ticket and provide feedback at https://supporttickets.intel.com/.

This function initializes a regular expression state structure pRegExpState in the external buffer. The size of this buffer must be computed previously by calling the function ippsRegExpGetSize. The function compiles the initial pattern of regular expressions pPattern in accordance with the compiling options specified by pOptions, converts it to the specific internal form, and stores it in the initialized structure. This structure is used by the function ippsRegExpFind to perform matching operation.

If the compiling is not completed, the function returns the pointer pErrOffset pointed to the position in the pattern where the compiling is interrupted.

NOTE:

The parameter pPattern must be the same for both functions ippsRegExpInit and ippsRegExpGetSize.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error condition if one of the specified pointers is NULL.

ippStsRegExpOptionsErr

Indicates an error if specified options are incorrect

ippStsRegExpQuantifierErr

Indicates an error if the quantifier is incorrect

ippStsRegExpGroupingErr

Indicates an error if the grouping is incorrect

ippStsRegExpBackRefErr

Indicates an error if the back reference is incorrect

ippStsRegExpChClassErr

Indicates an error if the character class is incorrect

ippStsRegExpMetaChErr

Indicates an error if the metacharacter is incorrect