Reads the characteristics of superclasses or subclasses.
Workload Manager Library (libwlm.a)
The wlm_read_classes subroutine is used to get the characteristics of the superclasses or the subclasses of a given subclass of a Workload Manager (WLM) configuration.
If your application specifically needs to access the properties of the classes as described in the /etc/wlm/current configuration, you must specify current as the configuration name in confdir.
If the name of a set of time-based configurations is passed in the confdir field, the wlm_read_classes subroutine reads the classes of the currently applicable configuration of the set.
If the number of elements copied by wlm_read_classes is strictly smaller than the number of elements passed as an argument, all the classes have been read. If it is equal, it may mean that some classes were not copied into the class_tbl array because its size is too small.
The maximum number of classes read by wlm_read_classes is 67 (64 user-defined superclasses plus System, Shared and Default) when reading superclasses and 63 (61 user-defined subclasses plus Shared and Default) when reading subclasses characteristics.
This operation does not require any special privileges and is accessible to all users.
Item | Description |
---|---|
wlmargs | Specifies the
address of a struct wlm_args data structure.
The following fields of the wlm_args structure and the embedded substructures need to be provided:
All the other fields can be left uninitialized. |
Item | Description |
---|---|
class_tbl | Specifies the address of an array of structures of type struct class_definition. Upon successful return from wlm_read_classes, this array contains the characteristics of the classes read. |
nclass | Specifies the address of an integer containing the maximum number of element (class definitions) for wlm_read_classes to copy into the array above. If the call to wlm_read_classes is successful, this integer contains the number of elements actually copied. |
Upon successful completion, the wlm_read_classes subroutine returns a value of 0. If the wlm_read_classes subroutine is unsuccessful, a nonzero value is returned.
For a list of the possible error codes returned by the WLM API functions, see the description of the wlm.h header file.