Interface WBEMClient

This string MUST either contain a valid CIM Association class name or be null. It filters the Objects returned to contain only Objects associated to the source Object via this CIM Association class or one of its subclasses.

This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.

This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the source Object plays the specified role. (i.e. the Property name in the Association class that refers to the source Object matches this value) If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are examined.

This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the Object returned plays the specified role. (i.e. the Property name in the Association class that refers to the Object returned matches this value) If "Dependent" is specified, then only Associations in which the Object returned is the "Dependent" reference are examined.

If true, all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included in the Objects returned. If false, no Qualifiers are present in each Object returned.

If true, the CLASSORIGIN attribute will be present on all appropriate elements in the Objects returned. If false, no CLASSORIGIN attributes are present in the Objects returned. CLASSORIGIN is attached to an element (properties, methods, references) to indicate the class in which it was first defined.

An array of property names used to filter what is contained in the Objects returned. Each CIMClass or CIMInstance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally.
An empty array indicates that no properties should be included in the Objects returned.
A null value indicates that all properties should be contained in the Objects returned.
NOTE: Properties should not be specified in this parameter unless a non-null value is specified in the resultClass parameter.

This string MUST either contain a valid CIM Association class name or be null. It filters the Objects returned to contain only Objects associated to the source Object via this CIM Association class or one of its subclasses.

This string MUST either contain a valid CIM Class name or be null. It filters the Objects returned to contain only the Objects of this Class name or one of its subclasses.

This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the source Object plays the specified role. (i.e. the Property name in the Association class that refers to the source Object matches this value) If "Antecedent" is specified, then only Associations in which the source Object is the "Antecedent" reference are examined.

This string MUST either contain a valid Property name or be null. It filters the Objects returned to contain only Objects associated to the source Object via an Association class in which the Object returned plays the specified role. (i.e. the Property name in the Association class that refers to the Object returned matches this value) If "Dependent" is specified, then only Associations in which the Object returned is the "Dependent" reference are examined.

If true, the CLASSORIGIN attribute will be present on all appropriate elements in the Objects returned. If false, no CLASSORIGIN attributes are present in the Objects returned. CLASSORIGIN is attached to an element (properties, methods, references) to indicate the class in which it was first defined.

An array of property names used to filter what is contained in the Objects returned. Each CIMClass or CIMInstance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally.
An empty array indicates that no properties should be included in the Objects returned.
A null value indicates that all properties should be contained in the Objects returned.
NOTE: Properties should not be specified in this parameter unless a non-null value is specified in the resultClass parameter.

The filterQueryLanguage represents the query language for the filterQuery argument. This must be left null if a filterQuery is not supplied.
If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned.
If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set.
If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned.
If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.

If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and ContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.

Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.

If true, the enumeration returned contains the specified class and all subclasses. If false, the enumeration returned contains only the contents of the first level children of the specified class.

If true, only elements (properties, methods and qualifiers) defined in, or overridden in the class are included in the response. If false, all elements of the class definition are returned.

If true, all Qualifiers for each Class and its elements ( properties, methods, references). If false, no Qualifiers are present in the classes returned.

If true, the CLASSORIGIN attribute MUST be present on all appropriate elements in each classes returned. If false, no CLASSORIGIN attributes are present in each class returned. CLASSORIGIN is attached to an element to indicate the class in which it was first defined.

If true, the enumeration returned will contain the names of all classes derived from the class being enumerated. If false , the enumeration returned contains only the names of the first level children of the class.

The filterQueryLanguage represents the query language for the filterQuery argument. This must be left null if a filterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.

If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and ContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.

Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.

If true, the enumeration returned contains all instances of the specified class and all classes derived from it. If false , only names of instances of the specified class are returned.

If true, only elements (properties, methods, references) overridden or defined in the class are included in the instances returned.

If true, the CLASSORIGIN attribute will be present on all appropriate elements in the instances returned. If false, no CLASSORIGIN attributes are present in the instances returned. CLASSORIGIN is attached to an element (properties, methods, references) to indicate the class in which it was first defined.

An array of property names used to filter what is contained in the instances returned. Each instance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be returned. A null value indicates that all properties should be returned.

If true, the enumeration returned contains all instances of the specified class and all classes derived from it. If false , only names of instances of the specified class are returned.

If true, the CLASSORIGIN attribute will be present on all appropriate elements in the instances returned. If false, no CLASSORIGIN attributes are present in the instances returned. CLASSORIGIN is attached to an element (properties, methods, references) to indicate the class in which it was first defined.

An array of property names used to filter what is contained in the instances returned. Each instance returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be returned. A null value indicates that all properties should be returned.

The filterQueryLanguage represents the query language for the filterQuery argument. This must be left null if a filterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.

If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and ContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.

Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.

A string containing the text of the query.

A string that identifies the query language to use to parse the query string specified.

The filterQueryLanguage represents the query language for the filterQuery argument. This must be left null if a filterQuery is not supplied. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

The filterQuery specifies a query in the form of the query language specified by the filterQueryLanguage parameter. If this value is not null, the filterQueryLanguage parameter must be non-null. This value will act as an additional filter on the result set. If the implementation does not support the query language specified, the CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED error will be returned. If the implementation does not support filtered enumerations, the CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED error will be returned.

The returnQueryResultClass controls whether a class definition is returned in QueryResultClass. If it is set to false, QueryResultClass shall be set to NULL on output. If it is set to true, the value of the QueryResultClass on output shall be a class definition that defines the properties (columns) of each row of the query result.

This input parameter determines the minimum time the CIM server shall maintain the open enumeration session after the last Open or Pull operation (unless the enumeration session is closed). If the operation timeout is exceeded, the implementation may close the enumeration session at any time, releasing any resources allocated to the enumeration session. An OperationTimeout of 0 means that there is no operation timeout. That is, the enumeration session is never closed based on time. If OperationTimeout is NULL, the implementation shall choose an operation timeout. All other values for OperationTimeout specify the operation timeout in seconds. A implementation may restrict the set of allowable values for OperationTimeout. Specifically, the implementation may not allow 0 (no timeout). If the specified value is not an allowable value, the implementation shall return failure with the status code CIM_ERR_INVALID_OPERATION_TIMEOUT.

If true, requests that the operation resume when an error is received. If a implementation does not support continuation on error and ContinueOnError is true, it shall throw a WBEMException with the status code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. If a implementation supports continuation on error and ContinueOnError is true, the enumeration session shall remain open when a Pull operation fails, and any subsequent successful Pull operations shall return the set of elements that would have been returned if the failing Pull operations were successful. This behavior is subject to the consistency rules defined for pulled enumerations. If ContinueOnError is false, the enumeration session will be closed when either the operation completes successfully or when a WBEMExcetpion is thrown.

Defines the maximum number of elements that this Open operation can return. The implementation may deliver any number of elements up to MaxObjects but shall not deliver more than MaxObjects elements. An implementation may choose to never return any elements during an Open operation, regardless of the value of MaxObjectCount. Note that a CIM client can use a MaxObjectCount value of 0 to specify that it does not want to retrieve any instances in the Open operation.

The queryResultClass output parameter shall be set to NULL if the returnQueryResultClass input parameter is set to false. Otherwise, it shall return a class definition where each property of the class corresponds to one entry of the query select list. The class definition corresponds to one row of the query result. The class name of this returned class shall be "CIM_QueryResult". This class definition is valid only in the context of this enumeration.

If true, only elements (properties, methods, references) overridden or defined in the class are included in the CIMClass returned. If false, all elements of the class definition are returned.

If true, all Qualifiers for the class and its elements are included in the CIMClass returned. If false , no Qualifier information is contained in the CIMClass returned.

The class origin attribute is the name of the class that either originally defined or overrode the definition of the property or method. If true, the class Origin attribute will be present on all CIMClasses. If false, the class origin will not be present. pPropertyList

An array of property names used to filter what is contained in the CIMClass returned. The CIMClass returned only contains elements for the properties of the names specified. Duplicate and invalid property names are ignored and the request is otherwise processed normally. An empty array indicates that no properties should be returned. A null value indicates that all properties should be returned.

Returns: CIMClass meeting the criteria specified.

Throws: WBEMException If unsuccessful, one of the following status codes must be returned. The ORDERED list is:

CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters)
CIM_ERR_NOT_FOUND (the request CIM Class does not exist in the specified namespace)
CIM_ERR_FAILED (some other unspecified error occurred)

If true, only elements (properties, methods, references) overridden or defined in the class are included in the CIMInstance returned. If false, all elements of the class definition are returned.