| 1 | Management collection object handle | Input | Binary(4) |
| 2 | Management collection object repository name | Input | Char(10) |
| 3 | Format name | Input | Char(8) |
| 4 | Management collection object repository handle | Output | Binary(4) |
| 5 | Error code | I/O | Char(*) |
The Open Management Collection Object Repository (QpmOpenMgtcolRepo) API opens a specified repository of a management collection object for processing. The management collection object is identified by a handle which was created by the Open Management Collection Object (QpmOpenMgtcol) API. If the open operation is successful, a handle to the open repository is returned. This handle uniquely identifies the open repository and is used by these APIs:
The management collection object repository handle is valid until the repository is closed by the Close Management Collection Object Repository (QpmCloseMgtcolRepo) API. The repository handle is scoped to a job so that a repository opened in one thread can be used by another thread provided the handle is known.
The API caller must specify a format name which identifies the kind of processing to be performed on the repository data. This format name also defines the format of the input and output parameters of the Read Management Collection Object Data (QpmReadMgtcolData) API when this API is used with this repository.
A handle to an open management collection object. This handle was created by the Open Management Collection Object (QpmOpenMgtcol) API.
Name of a repository of a management collection object. Currently, the API supports repositories created by user-defined performance collection categories only.
Name of the format that defines the kind of processing to be performed on the data in this repository. Currently, the Management Collection Object APIs support format MCOD0100 only.
When this format is specified, the Read Management Collection Object Data (QpmReadMgtcolData) API will return raw data from the repository of the management collection object. No additional processing will be performed and the data will be treated as an unstructured sequence of bytes.
The format name also defines the format of the input and output parameters of the Read Management Collection Object Data (QpmReadMgtcolData) API when this API is called for this repository. See description of Read Management Collection Object Data (QpmReadMgtcolData) API for more details.
A handle to the open repository of the management collection object. This handle is used by other APIs to uniquely identify the open repository of the management collection object.
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Message ID | Error Message Text |
|---|---|
| CPF0AA2 E | Repository &1 is not found in a collection object. |
| CPF0AA3 E | Attempt to access unsupported repository. |
| CPF0AA4 E | Lock request was not satisfied in a specified time. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C3C E | Value for parameter &1 not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
[ Back to top | >Performance Management APIs | APIs by category ]