Change Configuration Description (QDCCCFGD) API
| 1 | Configuration description name | Input | Char(10) |
| 2 | Configuration description type | Input | Char(10) |
| 3 | Changes | Input | Char(*) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Change Configuration Object (QDCCCFGD) API changes the value of one or more parameters in an existing configuration description. This API is intended for applications using new configuration capabilities not yet available through CL commands.
Authorities and Locks
- Configuration description authority
- *CHANGE
Required Parameter Group
- Configuration description name
- INPUT; CHAR(10)
The name of the configuration description being changed. This parameter must be in uppercase.
- Configuration description type
- INPUT; CHAR(10)
The type of configuration description being changed. Possible values for this parameter are:
*CFGL Configuration list *CNNL Connection list *COSD Class of service description *CTLD Controller description *DEVD Device description *IPXD IPX description *LIND Line description *MODD Mode description *NTBD NetBIOS description *NWID Network interface *NWSD Network server description
- Changes
- INPUT; CHAR(*)
The changes to be made to the specified configuration description. The information must be in the following format:
- Number of variable length records
- BINARY(4)
The total number of all of the variable length records.
- Variable length records
- Each variable length record contains a keyword plus its associated new value. Refer to Format for Variable Length Record for the format of this field.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format for Variable Length Record
The following table shows the format for the variable length record. For a detailed description of each field, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Key |
| 4 | 4 | BINARY(4) | Length of new value |
| 8 | 8 | CHAR(*) | New value |
If the length of the new value is longer than the data length of the key field, the data is truncated to the right. No message is issued.
If the length of the new value is shorter than the data length of the key field, the data is padded with blanks to the right. No message is issued.
It is not an error to specify a key more than once. If duplicate keys are specified, the last specified value for that key is used.
Field Descriptions
Key. The keyword parameter of the configuration description to be changed. Only specific keywords can be changed. The following table lists the valid key for the key-field area of the variable length record:
| Key | Value | CFGD type | CFGD keyword |
|---|---|---|---|
| 201 | CHAR(5000) | *DEVD | USRDFNDTA |
Length of new value. The length of the new value to be assigned to the keyword.
New value. The value to which a specific keyword is to be set.
Validation of New Values
Inclusion of any keyword parameter and its accompanying values in this API implies that the parsing of the value is supported in this API at a level equivalent to that provided by a Change (CHG) command that supports the same keyword.
In addition to the CPF26C9 escape message signaled to the caller, one or more CPD messages are placed on the caller's job log by the API to more fully describe the syntax error found while parsing the new value.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF26A8 E | Configuration description type not valid for this API. |
| CPF26C7 E | Key not valid. |
| CPF26C9 E | New value not valid. |
| CPF260A E | Mode description not found. |
| CPF260F E | Configuration list not found. |
| CPF262C E | Mode description damaged. |
| CPF2625 E | Not able to allocate object &1. |
| CPF2634 E | Not authorized to object &1. |
| CPF266C E | Connection list not found. |
| CPF2670 E | Class of service description not found. |
| CPF2675 E | Class of service description damaged. |
| CPF27A4 E | Network interface description &1 not found. |
| CPF2702 E | Device description &1 not found. |
| CPF2703 E | Controller description &1 not found. |
| CPF2704 E | Line description &1 not found. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C4D E | Length &1 for key &2 not valid. |
| CPF3C88 E | Number of variable length records &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF8FCF E | IPX description not found. |
| CPF8F5D E | NetBIOS description not found. |
| CPF8104 E | Controller description &4 damaged. |
| CPF8105 E | Device description &4 damaged. |
| CPF811D E | Network interface description &4 damaged. |
| CPF811E E | Connection list damaged. |
| CPF8124 E | Configuration list damaged. |
| CPF8125 E | Line description &4 damaged. |
| CPF814D E | NetBIOS description &4 damaged. |
| CPF815C E | IPX description damaged. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R7