pegasus/cgi/htdocs/Attic/EnumerateInstances.html - diff

Return to EnumerateInstances.html CVS log

Up to [Pegasus] / pegasus / cgi / htdocs / Attic

Diff for /pegasus/cgi/htdocs/Attic/EnumerateInstances.html between version 1.2 and 1.8

version 1.2, 2001/02/06 15:47:12

version 1.8, 2004/02/17 11:39:00

Line 4

<tr>

<td width="50%" align="bottom"><h1>Enumerate Instances CIM Operation</h1><td>

</td>

</tr>

</table>

<hr>

<p>

Line 18

Line 20

The <TT>enumerateInstances</TT> method enumerates instances of a CIM

Class in the target Namespace.

<p><b><a href="#NameSpace">NameSpace</a></b>

<INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20">  String that defines the target namespace. See <a href="getnamespaces.html">NameSpace

<INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">  String that defines the target namespace. See <a href="enumeratenamespaces.html">NameSpace

Operations</a> for more information.

<p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30>   Defines

name of the Class

for which instance names are to be retrieved.  This must be a legal

class in the repository

<p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>                       

<p><b>LocalOnly</b>                

If true only CIM Elements overridden within definition of class are

returned.

If checked (true) only CIM Elements overridden within definition of class are

<p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">            

returned. Default is true

If checked, show Qualifiers for class and returned Properties, Methods,

<p><b>IncludeQualifiers</b>      <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">    If

checked (true), show Qualifiers for class and returned Properties, Methods,

and Method Parameters.

<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">       

<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigin" VALUE="true">   If checked (TRUE), CLASSORIGIN attribute will be returned for all

If checked (TRUE), CLASSORIGIN attribute will be returned for all

appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">

NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter

request. <a href="#PropertyList">See below</a>.

</form>

<hr>

<h2>RETURN</h2>

<h2>Additional Information</h2>

<P>The <TT>enumerateInstances</TT> method enumerates instances of a CIM

Class in the target Namespace.

NameSpace The NameSpace parameter is a string that defines the

target namespace \Ref{NAMESPACE}

target namespace. The <TT>ClassName</TT> input parameter defines the

ClassName The <TT>ClassName</TT> input parameter defines the

Class that is the basis for the enumeration. </P>

LocalOnly If the <TT>LocalOnly</TT> input parameter is

<b>

LocalOnly</b> If the <TT>LocalOnly</TT> input parameter is

<TT>true</TT>, this specifies that, for each returned Instance,

only elements (properties and qualifiers) overriden within the

definition of that Instance are included. If <TT>false</TT>,

all elements are returned. This parameter therefore effects a CIM

Server-side mechanism to filter certain elements of the returned object

based on whether or not they have been propagated from the parent

Class (as defined by the <TT>PROPAGATED</TT> attribute).

<p><b>IncludeQualifiers</b> If the <TT>IncludeQualifiers</TT> input

@param DeepInheritance If the <TT>DeepInheritance</TT> input

parameter is <TT>true</TT>, this specifies that, for each

returned Instance of the Class, all properties of the Instance MUST

be present (subject to constraints imposed by the other

parameters), including any which were added by subclassing the specified

Class. If <TT>false</TT>, each returned Instance includes only

properties defined for the specified Class.

@param IncludeQualifiersIf the <TT>IncludeQualifiers</TT> input

parameter is <TT>true</TT>, this specifies that all Qualifiers

for each Instance (including Qualifiers on the Instance

and on any returned Properties) MUST be included as

<TT><QUALIFIER></TT> elements in the response. If false no

<TT><QUALIFIER></TT> elements are present in each

returned Instance.

returned Instance. </p>

<p><b>IncludeClassOrigin</b> If the <TT>IncludeClassOrigin</TT> input

@param IncludeClassOrigin If the <TT>IncludeClassOrigin</TT> input

parameter is <TT>true</TT>, this specifies that the

<TT>CLASSORIGIN</TT> attribute MUST be present on all appropriate

elements in each returned Instance. If false, no

<TT>CLASSORIGIN</TT> attributes are present in each returned

Instance.

Instance. </p>

<p><b>PropertyList</b> If the <TT>PropertyList</TT> input parameter is not

@param PropertyList If the <TT>PropertyList</TT> input parameter is not

<TT>NULL</TT>, the members of the array define one or more Property

names. Each returned Instance MUST NOT include elements

for any Properties missing from this list. Note that if

Line 104

Line 94

the Server MUST ignore the duplicates but otherwise process the request

normally. If the <TT>PropertyList</TT> contains elements which are

invalid Property names for any target Instance, the Server MUST

ignore such entries but otherwise process the request normally.

ignore such entries but otherwise process the request normally. </p>

<hr>

@return If successful, the method returns zero or more named

<h2>Return</h2>

<p>If successful, the method returns zero or more named

Instances that meet the required criteria.

If unsuccessful, one of the following status codes MUST be returned

by this method, where the first applicable error in the list (starting

with the first element of the list, and working down) is the error

returned. Any additional method-specific interpretation of the error in

is given in parentheses.

is given in parentheses.</p>

<UL>

<LI>CIM_ERR_ACCESS_DENIED

Line 125

Line 116

basis for this enumeration does not exist)

<LI>CIM_ERR_FAILED (some other unspecified erroroccurred)</LI>

</UL>

<hr>

<h2>C++ APIs as defined in CIMOperations.h</h2>

<PRE>

virtual Array<InstanceDecl> enumerateInstances(

const String& nameSpace,

const String& className,

Boolean deepInheritance = true,

Boolean localOnly = true,

Boolean includeQualifiers = false,

Boolean includeClassOrigin = false,

const Array<String>& propertyList = _getStringArray()) = 0;

</PRE>

document.EnumerateInstances.hostaddress.value = top.hostAddress;

document.EnumerateInstances.debug.value = top.debug;

document.EnumerateInstances.NameSpace.value = top.NameSpace;

window.focus();

</script>

</body>

</html>

Legend:

Removed from v.1.2
changed lines
	Added in v.1.8

No CVS admin address has been configured