Hardware Resource APIs
The hardware resource APIs allow you to work with hardware resources. A hardware resource is an addressable piece of hardware on the system. A hardware resource is known to the system by its resource name. A resource entry is the reference to the hardware resource in the hardware resource information, which can be thought of as a list of the hardware resources on the system.
Some of the hardware resource APIs use a first attempt and next attempts to work with a list of items. The first attempt performs the requested action and returns an indication of whether the action completed successfully or failed. The next attempt repeats the requested action, continuing from the point in which the previous attempt stopped. Through the use of attempts, an API that returns items from a list can progress down the list, returning the items one at a time.
The hardware resource APIs and their functions are:
- Change Resource Entry Information (QRZCHGE) allows you to change the name of the resource and to do resource mapping.
- Create Handle (QRZCRTH) creates a handle that is used as a placeholder when accessing items in a list using thenextoption.
- Delete Handle (QRZDLTH) deletes a handle that was created using the Create Handle (QRZCRTH) API.
- Delete Resource Entry (QRZDLTE) deletes a resource entry.
- Retrieve Hardware Resource Information (QGYRHRI, QgyRtvHdwRscInfo) retrieves hardware resource information fields that provide a detailed description of the resource that is identified by the resource name parameter.
- Retrieve Hardware Resource List (QGYRHRL, QgyRtvHdwRscList) retrieves a list of hardware resource names and other hardware resource information fields.
- Retrieve Hardware Resource Relative (QRZRTVR) retrieves the resource name of a family member that matches the request criteria. The resource name then can be used to obtain more information about a specific hardware resource.
- Retrieve Resource Class Attributes (QRZRRCA) retrieves class-specific information or object type values for a logical resource.
- Retrieve Resource Information (QRZRRSI) retrieves selected fields of a hardware resource from a known resource name.
- Search Hardware Resource Entry (QRZSCHE) retrieves the resource name of a hardware resource that matches the request criteria. The resource name can be used with other hardware resource APIs to get more information about a specific hardware resource.