_CMPIEnumerationFT Struct Reference

#include <cmpi/cmpift.h>

List of all members.

Public Attributes
int	ftVersion
CMPIStatus(*	release )(CMPIEnumeration *en)
CMPIEnumeration *(*	clone )(const CMPIEnumeration *en, CMPIStatus *rc)
CMPIData(*	getNext )(const CMPIEnumeration *en, CMPIStatus *rc)
CMPIBoolean(*	hasNext )(const CMPIEnumeration *en, CMPIStatus *rc)
CMPIArray *(*	toArray )(const CMPIEnumeration *en, CMPIStatus *rc)

---

Detailed Description

This structure is a table of pointers providing access to Enumeration support sevices.

---

Member Data Documentation

int _CMPIEnumerationFT::ftVersion

Function table version

CMPIStatus(* _CMPIEnumerationFT::release)(CMPIEnumeration *en)

The Enumeration object will not be used any further and may be freed by CMPI run time system.

Parameters:

en

Enumeration this pointer.

Returns:

Service return status.

CMPIEnumeration*(* _CMPIEnumerationFT::clone)(const CMPIEnumeration *en, CMPIStatus *rc)

Create an independent copy of this Enumeration object. The resulting object must be released explicitly.

Parameters:

	en	Enumeration this pointer.
	rc	Output: Service return status (suppressed when NULL).

Returns:

Pointer to copied Enumeration object.

CMPIData(* _CMPIEnumerationFT::getNext)(const CMPIEnumeration *en, CMPIStatus *rc)

Get the next element of this Enumeration.

Parameters:

	en	Enumeration this pointer.
	rc	Output: Service return status (suppressed when NULL).

Returns:

Element value.

Referenced by CmpiEnumeration::getNext().

CMPIBoolean(* _CMPIEnumerationFT::hasNext)(const CMPIEnumeration *en, CMPIStatus *rc)

Test for any elements left in this Enumeration.

Parameters:

	en	Enumeration this pointer.
	rc	Output: Service return status (suppressed when NULL).

Returns:

True or false.

Referenced by CmpiEnumeration::hasNext().

CMPIArray*(* _CMPIEnumerationFT::toArray)(const CMPIEnumeration *en, CMPIStatus *rc)

Convert this Enumeration into an Array.

Parameters:

	en	Enumeration this pointer.
	rc	Output: Service return status (suppressed when NULL).

Returns:

The Array.

Referenced by CmpiEnumeration::toArray().

---

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

• cmpi/cmpift.h