<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation"> <title>Open Management Collection Object Repository (QpmOpenMgtcolRepo) API</title> <!-- Begin Header Records --> <!-- All rights reserved. Licensed Materials Property of IBM --> <!-- US Government Users Restricted Rights --> <!-- Use, duplication or disclosure restricted by --> <!-- GSA ADP Schedule Contract with IBM Corp. --> <!-- Created for V5R2 --> <!-- Change History: --> <!-- YYMMDD USERID Change description --> <!-- File cleanup completed Feb 2002 by v2cdijab --> <!-- End Header Records --> <link rel="stylesheet" type="text/css" href="../rzahg/ic.css"> </head> <body> <a name="Top_Of_Page"></a> <!-- Java sync-link --> <script type="text/javascript" language="Javascript" src="../rzahg/synch.js"> </script> <h2>Open Management Collection Object Repository (QpmOpenMgtcolRepo) API</h2> <div class="box" style="width: 80%;"> <br> Required Parameter Group:<br> <!-- iddvc RMBR --> <br> <table width="100%"> <tr> <td align="center" valign="top" width="10%">1</td> <td align="left" valign="top" width="55%">Management collection object handle</td> <td align="left" valign="top" width="15%">Input</td> <td align="left" valign="top" width="20%">Binary(4)</td> </tr> <tr> <td align="center" valign="top">2</td> <td align="left" valign="top">Management collection object repository name</td> <td align="left" valign="top">Input</td> <td align="left" valign="top">Char(10)</td> </tr> <tr> <td align="center" valign="top">3</td> <td align="left" valign="top">Format name</td> <td align="left" valign="top">Input</td> <td align="left" valign="top">Char(8)</td> </tr> <tr> <td align="center" valign="top">4</td> <td align="left" valign="top">Management collection object repository handle</td> <td align="left" valign="top">Output</td> <td align="left" valign="top">Binary(4)</td> </tr> <tr> <td align="center" valign="top">5</td> <td align="left" valign="top">Error code</td> <td align="left" valign="top">I/O</td> <td align="left" valign="top">Char(*)</td> </tr> </table> <br> Service Program Name: QPMAAPI<br> <!-- iddvc RMBR --> <br> Default Public Authority: *EXCLUDE<br> <!-- iddvc RMBR --> <br> Threadsafe: Yes<br> <!-- iddvc RMBR --> <br> </div> <p>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 <a href="qpmopenmgtcol.htm">Open Management Collection Object (QpmOpenMgtcol) API</a>. 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:</p> <ul> <li><a href="qpmclosemgtcolrepo.htm">Close Management Collection Object Repository (QpmCloseMgtcolRepo) API</a></li> <li><a href="qpmreadmgtcoldata.htm">Read Management Collection Object Data (QpmReadMgtcolData) API</a></li> </ul> <p>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.</p> <p>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.</p> <br> <h3>Authorities and Locks</h3> <dl> <dt><em>API Public Authority</em></dt> <dd>*EXCLUDE</dd> </dl> <br> <h3>Required Parameter Group</h3> <dl> <dt><strong>Management collection object handle</strong></dt> <dd>INPUT; BINARY(4) <p>A handle to an open management collection object. This handle was created by the Open Management Collection Object (QpmOpenMgtcol) API.</p> </dd> <dt><strong>Management collection object repository name</strong></dt> <dd>INPUT; CHAR(10) <p>Name of a repository of a management collection object. Currently, the API supports repositories created by user-defined performance collection categories only.</p> </dd> <dt><strong>Format name</strong></dt> <dd>INPUT; CHAR(8) <p>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.</p> <p>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.</p> <p>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 <a href= "qpmreadmgtcoldata.htm">Read Management Collection Object Data (QpmReadMgtcolData) API</a> for more details.</p> </dd> <dt><strong>Management collection object repository handle</strong></dt> <dd>OUTPUT; BINARY(4) <p>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.</p> </dd> <dt><strong>Error code</strong></dt> <dd>I/O; CHAR(*) <p>The structure in which to return error information. For the format of the structure, see <a href="../apiref/error.htm#hdrerrcod">Error code parameter</a>.</p> </dd> </dl> <br> <h3>Error Messages</h3> <table width="100%" cellpadding="5"> <!-- cols="15 85" --> <tr> <th align="left" valign="top" nowrap>Message ID</th> <th align="left" valign="top">Error Message Text</th> </tr> <tr> <td align="left" valign="top">CPF0AA2 E</td> <td align="left" valign="top">Repository &1 is not found in a collection object.</td> </tr> <tr> <td align="left" valign="top">CPF0AA3 E</td> <td align="left" valign="top">Attempt to access unsupported repository.</td> </tr> <tr> <td align="left" valign="top">CPF0AA4 E</td> <td align="left" valign="top">Lock request was not satisfied in a specified time.</td> </tr> <tr> <td align="left" valign="top">CPF24B4 E</td> <td align="left" valign="top">Severe error while addressing parameter list.</td> </tr> <tr> <td align="left" valign="top">CPF3C21 E</td> <td align="left" valign="top">Format name &1 is not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3C3C E</td> <td align="left" valign="top">Value for parameter &1 not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3CF1 E</td> <td align="left" valign="top">Error code parameter not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3CF2 E</td> <td align="left" valign="top">Error(s) occurred during running of &1 API.</td> </tr> </table> <br> <hr> API introduced: V5R2 <hr> <table align="center" cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"> <a href="#Top_Of_Page">Top</a> | <a href="perfmgmt.htm">Performance Management APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </body> </html>