NLMATCHINIT

Syntax

  I                      BA       I            IV
  result := NLMATCHINIT (pattern, pattern_len, langid,
                         BA            I
                         comp_pattern, comp_buf_size);

Functional Return

Parameters

pattern

Byte array (required)

A byte array containing the pattern to be compiled. Leading and training spaces are ignored.

A pattern consists of a series of special characters that indicate the type of data to be selected. These characters are:

Char	Selected
a	Uppercase, lowercase, or 16-bit Asian character
u	Uppercase alphabetic character
l	Lowercase alphabetic character
b	Blank (space)
d	Digits, as defined in the NLS character attribute table
?	Any character

Other metacharacter indicate choice, grouping, and ranges:

Char	Selected
!	Transparency
,	Choice
:	Range
{ }	Grouping
[ ]	Optional
+	Repetition (one or more)
*	Repetition (zero or more)

Pattern operators are evaluated in the following order, where x and y are any character for the language:

Char	Operation	Example
!	Transparency	!x
:	Range	x:y
+ / *	Repetition (1 / 0 or more)	x+ or x*
	Concatenation	xy
,	Choice	x,y

The repetition, concatenation, and choice operators can be used with patterns. For instance: x,y are any pattern in this case.

pattern_len

Integer (required)

Length, in bytes, of the pattern to be compiled.

langid

Integer by value (required)

The language ID number of the language to be used in compiling the pattern.

comp_pattern

Byte array (required)

A byte array specifying where the compiled pattern is to be constructed.

comp_buf _size

Integer (required)

The length of the comp_pattern, in bytes, available for constructing the compiled pattern.

Operation Notes

Related Information