Open Management Collection Object (QpmOpenMgtcol) API

Required Parameter Group:

1	Qualified object name	Input	Char(20)
2	Management collection object handle	Output	Binary(4)
3	Error code	I/O	Char(*)

  Service Program Name: QPMAAPI

  Default Public Authority: *EXCLUDE

  Threadsafe: Yes

The Open Management Collection Object (QpmOpenMgtcol) API opens a specified management collection object for processing and returns a handle to the open management collection object. This handle uniquely identifies the open management collection object and is used by the following APIs:

The management collection object handle is valid until the management collection object is closed by the Close Management Collection Object (QpmCloseMgtcol) API. The handle is scoped to a job so that a management collection object opened in one thread can be used by another thread provided the handle is known.

Authorities and Locks

API Public Authority

*EXCLUDE

Authority to library containing collection object

*EXECUTE

If the open operation was successful, a *SHRRD lock is placed on the management collection object.

Required Parameter Group

Qualified object name

INPUT; CHAR(20)

Name of a management collection object and the library in which it is located. The first 10 characters contain the object name and the second 10 characters contain the library name.

The system supports management collection objects with different attributes; they contain different information. The Management Collection Object APIs support only collection objects which are created by the Collection Services collector. These collection objects have the attribute *PFR.

Management collection object handle

OUTPUT; BINARY(4)

A handle to the open management collection object. This handle is used by the Close Management Collection Object (QpmCloseMgtcol) API and the Open Management Collection Object Repository (QpmOpenMgtcolRepo) API to uniquely identify the open management collection object.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Error Messages

Message ID	Error Message Text
CPF0A2B E	Not able to process management collection object &1 in library &2.
CPF0AA4 E	Lock request was not satisfied in a specified time.
CPF2105 E	Object &1 in &2 type *&3 not found.
CPF2110 E	Library &1 not found.
CPF2114 E	Cannot allocate object &1 in &2 type *&3.
CPF2207 E	Not authorized to use object &1 in library &3 type *&2.
CPF24B4 E	Severe error while addressing parameter list.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPF9810 E	Library &1 not found.

Message ID

Error Message Text

CPF0A2B E

Not able to process management collection object &1 in library &2.

CPF0AA4 E

Lock request was not satisfied in a specified time.

CPF2105 E

Object &1 in &2 type *&3 not found.

CPF2110 E

Library &1 not found.

CPF2114 E

Cannot allocate object &1 in &2 type *&3.

CPF2207 E

Not authorized to use object &1 in library &3 type *&2.

CPF24B4 E

Severe error while addressing parameter list.

CPF3CF1 E

Error code parameter not valid.

CPF3CF2 E

Error(s) occurred during running of &1 API.

CPF9810 E

Library &1 not found.