Add List Entry (Q1AADDLSTE) API
This API will allow a way to programmatically add an entry into a BRMS list. This can be called multiple times to add in more entries names.
| Required Parameter Group: | |||
| 1 | List name | Input | Char(10) |
| 2 | List entry information | Input | Char(*) |
| 3 | Length of list entry information | Input | Binary(4) |
| 4 | Format of list entry information | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
| Default Public Authority: *USE | |||
| Threadsafe: No | |||
Required Parameter Group
- List name
- INPUT CHAR(10)
Specifies the name of the list that the entry is being added to.
- List entry information
- INPUT CHAR(*)
The attributes of the list. The format of the list information is specified in the list format name parameter.
- Length of list entry information
- INPUT BINARY(4)
The number of bytes that the calling program provides for the list entry information format.
- Format of list entry information
- INPUT CHAR(8)
The format of the list entry information parameter.
The possible format names follow.- BLNA0100
- Add a backup link list entry. Note: The entry will always be appended to the list.
- BOBA0100
- Add a backup object list entry. Note: Support for controlling where in the list, the entry will be added.
- BOBA0200
- Add a backup object list entry. Note: Support for controlling where in the list, the entry will be added.
- Error code
- I/O CHAR(*)
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
List Entry Information Formats
BLNA0100 format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Link list entry type |
| 10 | 0A | CHAR(2) | Reserved |
| 12 | 0C | BINARY(4) | Link list path name structure offset |
| 16 | 10 | BINARY(4) | Link list path name structure length |
| * | * | CHAR(*) | Path name structure |
BOBA0100 format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Object list sequence number |
| 4 | 4 | CHAR(10) | Object list object library |
| 14 | 0E | CHAR(10) | Object list object name |
| 24 | 18 | CHAR(10) | Object list object type |
| 34 | 22 | CHAR(10) | Object list object member |
BOBA0200 format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Object list sequence number |
| 4 | 4 | CHAR(10) | Object list object library |
| 14 | 0E | CHAR(10) | Object list object name |
| 24 | 18 | CHAR(10) | Object list object type |
| 34 | 22 | CHAR(10) | Object list object member |
| 44 | 2C | CHAR(10) | Object list object attribute |
| 54 | 36 | CHAR(4) | Object list object include/exclude |
List Entry Information Format Field Descriptions
- Link list entry type
- Indicates if the path name is included in or omitted from the
backup. The possible values are:
- *INCLUDE
- The path will be included.
- *OMIT
- The path will be omitted.
- Link list path name length
- Specifies the length of the path name structure.
- Link list path name offset
- Specifies the offset from the start of the format data to where the path name structure is located.
- Object list object attribute
- Specifies the attribute of the object to be added to the entry
list. (This field is available on servers with IBM® i 7.2 and above.)The possible values are:
- *ALL
- All object attribute values are selected.
- *NONE
- Only objects that have no attribute value are selected.
- attribute-value
- Specify the attribute value of the objects to select.
- generic*-attribute-value
- Specify the generic attribute value of the objects to select.
- Object list object include/exclude
- Specifies whether to include or exclude the selected objects
from the save operation. (This field is available on servers with IBM i 7.2 and above.)The possible values are:
- *INC
- The selected objects are included in the save operation.
- *EXC
- The selected objects are excluded from the save operation.
- Object list object library
- Specifies the name of the library that contains the object that is a member of the object list. In V6R1M0 and greater a generic library name is supported.
- Object list object member
- Specifies the database member entry to be added in the list entry.
The possible values are:
- *ALL
- All members are saved from the specified file, if an object type of *FILE is specified, otherwise it will be ignored on the save.
- generic*-member-name
- Specify the generic name of the members to be saved from the specified file. The object list object type for this entry must be *FILE.
- member-name
- Specify the name of the member to be saved from the given file. The object list object type for this entry must be *FILE.
- blanks
- If not *FILE type.
- Object list object name
- Specifies the name of the object to be added to the list entry.
The possible values are:
- *ALL
- Include all objects in the library.
- generic*-object-name
- Specify a generic object name, such as AP* would include all objects that begin with the letters AP.
- object-name
- Specify the name of an object.
- Object list object type
- Specifies the type of the object to be added to the list entry.
The possible values are:
- *ALL
- All object types are included for the chosen object.
- object-type
- Specify the name of any permitted system object type.
- Object list sequence number
- Indicates where the entry is to be placed in the current list
of entries. The possible values are:
- -1
- Specifies to add to last list entry.
- 1-9999
- Specifies the number to use. Type a sequence number from 1 through
9999. The lowest number indicates that the entry is to be processed
first and the highest number indicates the entry is to be processed
last. If there is already a sequence number with that number it will
be added after. The sequence numbers stored in increments of 10 with
a max of 999 entries. Note: It is recalculated after each api call.
- Path name structure
- The path name must be specified in an NLS-enabled format using the Qlg_Path_Name_T structure. For more information about the Qlg_Path_Name_T structure, see the info center.
Error Messages
- CPF1E64 E Parmeter value * not valid for program *.
- CPF24B4 E Severe error while addressing parameter list.
- CPF3CF1 E Error code parameter not valid.
- CPF5222 E Name is not valid.
- CPF9800 E All CPF98xx messages could be signaled. Xx is from 01 to FF.
- BRM3C1E E Required parameter omitted.
- BRM3C4B E Value not valid for field at offset *.
- BRM3C4C E Value not valid for field at offset *
- BRM3C91 E Product feature required.
- BRM3C94 E Object not created.
- BRM3C99 E Unexpected condition with * API. Reason *.
- BRM402A E BRMS product initialization required.
- BRM4040 E Access denied for user *.
- BRM4107 E Length * not correct.
- BRM4108 E Format name * not correct.
- BRM410A E Sequence * not correct.
- BRM4133 E * cannot be changed