RegExpSetFormat

DEPRECATED. Sets source encoding format for given compiled pattern.

Syntax

IppStatus ippsRegExpSetFormat(IppRegExpFormat fmt, IppRegExpState* pRegExpState);

Include Files

ippch.h

Domain Dependencies

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

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

Parameters

fmt	New source encoding mode.
pRegExpState	Pointer to the structure containing internal form of a regular expression.

Description

The function sets the new source encoding format for given compiled pattern. Default source encoding format after ippsRegExpInit is UTF-8 with ASCII auto detection.

The enumeration IppRegExpFormat for representing a source encoding mode is defined as

typedef enum {

ippFmtASCII=0,

ippFmtUTF8,

}IppRegExpFormat;

CAUTION

The function ippsRegExpFind returns ippStsRegExpErr when pattern and source string are coded with different encoding, or pattern contains unsupported features by chosen encoding format.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when the pRegExpState pointer is NULL.
ippStsRangeErr	Indicates an error when mode is not a valid element of the enumerated type IppRegExpFormat.