Each list API provides a input parameter, header, and list data section.
List Section | Contents |
---|---|
Input parameter section | An exact copy of the parameters coded in the call to the API. In general, this section contains all the parameters available. |
Header section | Parameter feedback and global information about each object. Some APIs do not use this section; in those cases, the value of the size-of-header-section field is zero. |
List data section | The generated list data. All entries in the list section are the same length. |
When you retrieve list entry information from a user space, you should use the entry size designated in your application. To get the next entry, use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid.
Some APIs may be able to return more information to the application than fits in a receiver variable or a user space. The information returned is correct, but not complete.
If the list information is not complete, the first item and possibly the second item occur:
If an indicator of a partial list is returned, the application should call the API again with the continuation handle in the list header section of the API and specify that the list begin with the next entry to be returned.