CMPIEnumerationFilterFT Struct Reference

Function table of CMPIEnumerationFilter encapsulated data type object. More...

#include <cmpift.h>

Data Fields
CMPIVersion	ftVersion
	CMPI version supported by the MB for this function table. More...
CMPIStatus(*	release )(CMPIEnumerationFilter *ef)
	Release a CMPIResult object. More...
CMPIEnumerationFilter *(*	clone )(const CMPIEnumerationFilter *ef, CMPIStatus *rc)
	Create an independent copy of a CMPIEnumerationFilter object. More...
CMPIBoolean(*	match )(const CMPIEnumerationFilter *ef, const CMPIInstance *inst, CMPIStatus *rc)
	Test whether an instance matches the filter represented by a CMPIEnumerationFilter object. More...

Detailed Description

Function table of CMPIEnumerationFilter encapsulated data type object.

Addition:

Added in CMPI 2.1.

Field Documentation

CMPIVersion CMPIEnumerationFilterFT::ftVersion

CMPI version supported by the MB for this function table.

Any earlier CMPI versions are implicitly also supported.

See CMPIVersion<NNN> for valid CMPI version numbers.

CMPIStatus(* CMPIEnumerationFilterFT::release)(CMPIEnumerationFilter *ef)

Release a CMPIResult object.

CMPIEnumerationFilterFT.release() releases a CMPIEnumerationFilter object. This indicates to the MB that the object (including any objects it contains) will no longer be used by the MI. The MB may free (=reclaim) the memory associated with the object during the call to this function, or later during some garbage collection cycle (see Subclause 4.1.7 of the CMPI Standard).

Parameters

ef	Points to the CMPIEnumerationFilter object that is to be released. That object shall have been created using CMPIEnumerationFilterFT.clone().

Returns

CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The ef handle is invalid.

Convenience Function

CMRelease()

Addition:

Added in CMPI 2.1.

CMPIEnumerationFilter*(* CMPIEnumerationFilterFT::clone)(const CMPIEnumerationFilter *ef, CMPIStatus *rc)

Create an independent copy of a CMPIEnumerationFilter object.

CMPIEnumerationFilterFT.clone() creates an independent copy of a CMPIEnumerationFilter object.

Parameters

	ef	Points to the CMPIEnumerationFilter object that is to be copied.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a pointer to the copied CMPIEnumerationFilter object will be returned.

The returned CMPIEnumerationFilter object shall be explicitly released by the MI using CMPIEnumerationFilterFT.release().

If not successful, NULL will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The ef handle is invalid.

Convenience Function

CMClone()

Addition:

Added in CMPI 2.1.

CMPIBoolean(* CMPIEnumerationFilterFT::match)(const CMPIEnumerationFilter *ef, const CMPIInstance *inst, CMPIStatus *rc)

Test whether an instance matches the filter represented by a CMPIEnumerationFilter object.

CMPIEnumerationFilterFT.match() tests whether an instance matches the filter represented by a CMPIEnumerationFilter object. The filter matches the instance if the conditions defined in the filter are met by the properties of the instance.

The MB's implementation of this function should be efficient.

Parameters

	ef	Points to the CMPIEnumerationFilter object for this function.
	inst	Points to the CMPIInstance object to be tested against the filter.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIBoolean value indicating the test result will be returned as follows:

• True indicates that the instance matches the filter;
• False indicates that this is not the case.

If not successful, False will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

• CMPI_RC_OK - Function successful.
• CMPI_RC_ERR_INVALID_HANDLE - The ef handle is invalid.
• CMPI_RC_ERR_INVALID_QUERY - The filterQuery is not a valid query in the specified filter query language
• CMPI_RC_ERR_QUERY_FEATURE_NOT_SUPPORTED - A feature of the query language is not supported.
• CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function

CMFilterMatch()

Addition:

Added in CMPI 2.1.

Bug:

The CMPI Standard misses to define when a filter matches. This should be added, by using the definition from the header file.

---

The documentation for this struct was generated from the following file:

• cmpift.h