(file) Return to EnumerateClassNames.html CVS log (file) (dir) Up to [Pegasus] / pegasus / cgi / htdocs

 1 mike  1.1 <html>
 2             <body bgcolor="#CCCCCC">
 3               <table width="100%">
 4                 <tr>
 5 karl  1.3 	<td width="50%" align="bottom"><h1>EnumerateClassNames Operation</h1><td>
 6 mike  1.1 	<td width="50%" align="right">
 7 karl  1.5 	    <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
 8 mike  1.1 	</td>
 9                 </tr>
10               </table>
11 karl  1.3     <hr>
12 mike  1.1     <form METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
13                 <INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateClassNames">
14 karl  1.3       <p>
15               The <TT>enumerateClassNames</TT> operation is used to enumerate the
16               names of subclasses of a CIM Class in the target Namespace.
17                 <p><b><a href="#NameSpace">NameSpace</a></b>
18 mike  1.1         <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20">
19 karl  1.3       String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
20 karl  1.4       Operations</a> for more information.<p><b><a href="http://www.opengroup.org/management#className">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30>&nbsp;
21 karl  1.6       Defines the name of the Class that is the basis for the enumeration.. Null (no entry) lists all
22 karl  1.3       class names in the Namespace<p><b><a href="#DeepInheritance">DeepInheritance</a></b>
23                   <INPUT TYPE="checkbox" NAME="DeepInheritance" VALUE="true" checked>&nbsp;
24                 If true return names of all subclasses of specified class. If false, only
25                 immediate subclasses are returned.
26                 <p><INPUT TYPE="submit" VALUE="Submit Request">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
27                 <INPUT TYPE="reset" VALUE="Reset">
28 mike  1.1     </form>
29 karl  1.3     <hr>
30           
31               <h2>Request Return&nbsp;</h2>
32           
33               <p> If successful, the method returns zero or more names of Classes that
34               meet the requested criteria as a CIM Array.
35           
36               <p>If unsuccessful, one of the following status codes MUST be returned by this
37               method, where the first applicable error in the list (starting with the
38               first element of the list, and working down) is the error returned. Any
39               additional method-specific interpretation of the error in is given in
40               parentheses.
41               <UL>
42                 <LI>CIM_ERR_ACCESS_DENIED
43                 <LI>CIM_ERR_NOT_SUPPORTED
44                 <LI>CIM_ERR_INVALID_NAMESPACE&nbsp;
45                 <LI>CIM_ERR_INVALID_PARAMETER (including missing,
46                   duplicate,&nbsp;unrecognized or otherwise incorrect parameters)
47                 <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
48                   basis for this enumeration does not exist)
49                 <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
50 karl  1.3     </UL>
51 karl  1.5 
52 karl  1.3     <hr>
53               <h2>Additional Information on the Fields</h2>
54               <p><a name="NameSpace"><b>NameSpace</b></a> - The NameSpace parameter is a string that defines the
55               target namespace
56           
57               <p><a name="className"><b>className</b></a> - The <TT>ClassName</TT> input parameter defines the Class
58 karl  1.6     that is the basis for the enumeration.&nbsp;Note that the class named is not
59               retrieved as part of the enumeration. Thus, if there are no subclasses to
60               the named class, zero classe names are returned.
61 karl  1.3 
62               <p><a name="DeepInheritance"><b>DeepInheritance</b></a> - If the DeepInheritance input parameter is true, this
63               specifies that the names of all subclasses of the specified Class should be
64               returned (if the ClassName input parameter is absent, this implies that the
65               names of all Classes in the target Namespace should be returned).  If false,
66               only the names of immediate child subclasses are returned (if the ClassName
67               input parameter is NULL, this implies that the names of all base Classes in
68 karl  1.6     the target Namespace should be returned.
69 karl  1.3     <hr>
70           
71               <h2>C++ Call</h2>
72 karl  1.5 
73 karl  1.3     <PRE>
74               virtual Array<String> enumerateClassNames(
75               	const String&amp; nameSpace,
76               	const String&amp; className = String::EMPTY,
77               	Boolean deepInheritance = false) = 0;
78               </PRE>
79           
80           
81 mike  1.1   </body>
82           </html>

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2