(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 karl  1.8     <form name="EnumerateClassNames" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient" >
13 mike  1.1       <INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateClassNames">
14 karl  1.10       <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
15                  <INPUT TYPE="hidden" NAME="debug" VALUE="">
16 karl  1.3        <p>
17                The <TT>enumerateClassNames</TT> operation is used to enumerate the
18                names of subclasses of a CIM Class in the target Namespace.
19                  <p><b><a href="#NameSpace">NameSpace</a></b>
20 karl  1.9          <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">
21 karl  1.3        String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
22 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;
23 karl  1.6        Defines the name of the Class that is the basis for the enumeration.. Null (no entry) lists all
24 karl  1.3        class names in the Namespace<p><b><a href="#DeepInheritance">DeepInheritance</a></b>
25                    <INPUT TYPE="checkbox" NAME="DeepInheritance" VALUE="true" checked>&nbsp;
26                  If true return names of all subclasses of specified class. If false, only
27                  immediate subclasses are returned.
28                  <p><INPUT TYPE="submit" VALUE="Submit Request">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
29                  <INPUT TYPE="reset" VALUE="Reset">
30 mike  1.1      </form>
31 karl  1.3      <hr>
32            
33 karl  1.8      <h2>Request Return&nbsp;</h2>
34 karl  1.3  
35                <p> If successful, the method returns zero or more names of Classes that
36                meet the requested criteria as a CIM Array.
37            
38                <p>If unsuccessful, one of the following status codes MUST be returned by this
39                method, where the first applicable error in the list (starting with the
40                first element of the list, and working down) is the error returned. Any
41                additional method-specific interpretation of the error in is given in
42                parentheses.
43                <UL>
44                  <LI>CIM_ERR_ACCESS_DENIED
45                  <LI>CIM_ERR_NOT_SUPPORTED
46                  <LI>CIM_ERR_INVALID_NAMESPACE&nbsp;
47                  <LI>CIM_ERR_INVALID_PARAMETER (including missing,
48                    duplicate,&nbsp;unrecognized or otherwise incorrect parameters)
49                  <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
50                    basis for this enumeration does not exist)
51                  <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
52                </UL>
53 karl  1.5  
54 karl  1.3      <hr>
55                <h2>Additional Information on the Fields</h2>
56                <p><a name="NameSpace"><b>NameSpace</b></a> - The NameSpace parameter is a string that defines the
57                target namespace
58            
59                <p><a name="className"><b>className</b></a> - The <TT>ClassName</TT> input parameter defines the Class
60 karl  1.6      that is the basis for the enumeration.&nbsp;Note that the class named is not
61                retrieved as part of the enumeration. Thus, if there are no subclasses to
62                the named class, zero classe names are returned.
63 karl  1.3  
64                <p><a name="DeepInheritance"><b>DeepInheritance</b></a> - If the DeepInheritance input parameter is true, this
65                specifies that the names of all subclasses of the specified Class should be
66                returned (if the ClassName input parameter is absent, this implies that the
67                names of all Classes in the target Namespace should be returned).  If false,
68                only the names of immediate child subclasses are returned (if the ClassName
69                input parameter is NULL, this implies that the names of all base Classes in
70 karl  1.6      the target Namespace should be returned.
71 karl  1.3      <hr>
72            
73                <h2>C++ Call</h2>
74 karl  1.5  
75 karl  1.3      <PRE>
76                virtual Array<String> enumerateClassNames(
77                	const String&amp; nameSpace,
78                	const String&amp; className = String::EMPTY,
79                	Boolean deepInheritance = false) = 0;
80                </PRE>
81 karl  1.7    <hr><p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
82                 Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
83            
84                 <p style="margin-top: 0; margin-bottom: 0"> <font size="2">See (<a href="http://www.opengroup.org/management">http://www.opengroup.org/management</a>)
85                 for more information on Pegasus</font>
86            
87                 <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
88 karl  1.10     S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Friday, June 29, 2001 06:34:27 PM<!--webbot bot="Timestamp" i-CheckSum="55059" endspan -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89 karl  1.7       Copyright @ The Open Group 2001&nbsp;</font>
90 karl  1.3  
91 karl  1.10    <script>
92                   document.EnumerateClassNames.hostaddress.value = top.hostAddress;
93                   document.EnumerateClassNames.debug.value = top.debug;
94                   document.EnumerateClassNames.NameSpace.value = top.NameSpace;
95            	   window.focus();
96               </script>
97 karl  1.3  
98 mike  1.1    </body>
99            </html>

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2