The character string for matching to a directive. Only as many tokens (words
delimited by a space) as are provided are matched. Any extra tokens either on
the value string or the directive being considered for a match will not be
compared. For example a value string of Port 1234 junk willmatch a directive
of Port 1234. To match any directive, including comment lines, pass either a
NULL pointer or a string with no tokens on it such as a 0 length string.
value_len
INPUT:BINARY(4)
The length of the value string.
startdir
INPUT:BINARY(4)
The directive handle that specifies where to begin searching for a match. The
directive immediately following this one is the first one searched. If the startdir
parameter is passed as a NULL, then searching begins at the beginning of the
configuration file. If the startdir parameter is not passed as a NULL (omitted),
then the startdir parameter must be the handle to a main directive, and cannot
be a subdirective.
num
INPUT:BINARY(4)
The number of the match to be returned. The num parameter must be a
number greater than or equal to 0. If the value is 0, then the last matching
directive is returned. If the value is 1, the first match is returned. If the value is
2, the second match is returned, and so on.
case_sens
INPUT:BINARY(4)
The value of 0 (false) or a value of 1 (true), indicating whether matching of
tokens in the search string should be case sensitive. In most cases, except
where certain case-sensitive file paths are being considered, this parameter
should be 0 (false). Note that the searches for the actual directive name, which
is the first token on the line, is never case-sensitive.
dir
OUTPUT:BINARY(4)
The handle to the matched directive. If no directive is found, error HTPA110is
returned.
errcode
I/O:CHAR(*)
The structure in which to return error information.
Error messages
CPF3CF1 E
Error code parameter not valid.
HTPA001 E
Input parameter &1 not valid.
HTPA106 E
Input configuration handle not valid.
48 WebProgramming Guide V4R5