Find Config Object (QzuiFindConfigObject) API
The QzuiFindConfigObject() API allows you to search an IBM® HTTP Server for i configuration file for the object (and possibly value) specified and returns a handle to it.
| Required Parameter Group: | |||
| 1 | cfg | Input | Binary(4) |
| 2 | fdata | Input | Char(*) |
| 3 | fdata_size | Input | Binary(4) |
| 4 | format | Input | Char(8) |
| 5 | object | Output | Binary(4) |
| 6 | val | Output | Char(*) |
| 7 | val_size | Input | Binary(4) |
| 8 | val_actlen | Output | Binary(4) |
| 9 | errcode | I/O | Char(*) |
| Threadsafe: Yes | |||
If ″start″ is not specified, the configuration file scope is used. If a value is specified, the value is tokenized and compared with the tokens of the matching keywords. For example, if the keyword is ″BrowserMatch″ and the value is ″Mozilla/2″ the search would find ″BrowserMatch Mozilla/2 nokeepalive″. Also, the ″val″ field would contain ″Mozilla/2 nokeepalive″. You need only pass the object type and keyword. For example, to find a ″Port″ directive, set the object type to 1, the keyword to ″Port″ and fdata_size to 8. If the value field is not needed, set ″val_size″ to 0.
Authorities and locks
None.
Required parameter group
- cfg
- INPUT:BINARY(4)
Handle to the configuration file.
- fdata
- INPUT:CHAR(*)
Find data in format CFGF0110.
- fdata_size
- INPUT:BINARY(4)
Size of Find data format buffer.
- format
- INPUT:CHAR(8)
Name of format (CFGF0110).
- object
- OUTPUT:BINARY(4)
Handle to the object found (-1 indicates not found).
- val
- OUTPUT:CHAR(*)
Contains the whole value of the configuration object found.
- val_size
- INPUT:BINARY(4)
Size of value buffer.
- val_actlen
- OUTPUT:BINARY(4)
Actual size of value.
- errcode
- I/O:CHAR(*)
Error information structure.
CFGF0110 format
This data format is used by QzuiFindConfigObject() API.
| Offset | Type | Field |
|---|---|---|
| 0 | Binary(4) | Object type (0=directive, 1=scope) |
| 4 | Char(40) | Keyword object to search for (required) |
| 44 | Binary(4) | Case sensitive (0=insensitive, 1=sensitive) |
| 48 | Binary(4) | Where to search (0=entire configuration, 1=with scope specified in "Start", 2=start search at object specified in "Start", 3=start search at scope specified in object start) |
| 52 | Binary(4) | Start - the search start handle (0 if no start is to be used) |
| 56 | Binary(4) | Value when searching (0=no, 1=yes) |
| 60 | Char(100) | Value of object to search for |
Error messages
- CPF3C17 E
- Error occurred with input data parameter.
- CPF3C19 E
- Error occurred with receiver variable specified.
- CPF3C1D E
- Input variable length in parameter &1 not valid.
- CPF3C21 E
- Format name &1 not valid.
- CPF3CF1 E
- Error code parameter not valid.
- HTPA001 E
- Input parameter &1 not valid.
- HTPA106 E
- Input configuration handle not valid.
- HTPA121 E
- Object handle in parameter &1 not valid.
- HTPA122 E
- Object handle in parameter &1 not a scope.
- HTPA123 E
- No matching object found.