FindStringFirst

This method finds the first word in the workdoc according to the pSettings parameter. The search starts from the first word in the workdoc and the first FormatSetting search pattern.

Note: The method does not take the region settings into account.

Syntax

FindStringFirst(pWorkdoc as ISCBCdrWorkdoc, pSettings as SCBCdrFormatSettings, pFormatIndex as Long, pFoundString as String, pWordID as Long) as Boolean
Parameter Description
pWorkdoc The current workdoc.
pSettings The settings of the specific format string.
pFormatIndex Output parameter that contains the index of the matched format setting if
pMatched
is true.

contains the index of the format string that produced a successful match

Optional parameter. The default value is 0.

pFoundString Output parameter that contains the found string.

Optional parameter. The default value is "0".

pWordID Output parameter that contains the WordID of the best matching word in the workdoc.

Optional parameter. The default value is 0.

Return value

  • True: The string was found.
  • False: The string was not found.

See also