CMPI 2.1.0 API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
CMPISubCondFT Struct Reference
CMPISubCond Support (Subclause 8.12)

Function table of CMPISubCond 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 )(CMPISubCond *sc)
 Release a CMPISubCond object. More...
 
CMPISubCond *(* clone )(const CMPISubCond *sc, CMPIStatus *rc)
 Create an independent copy of a CMPISubCond object. More...
 
CMPICount(* getCount )(const CMPISubCond *sc, CMPIStatus *rc)
 Get the number of predicates in a CMPISubCond object. More...
 
CMPIPredicate *(* getPredicateAt )(const CMPISubCond *sc, CMPICount index, CMPIStatus *rc)
 Get a predicate in a CMPISubCond object by index. More...
 
CMPIPredicate *(* getPredicate )(const CMPISubCond *sc, const char *name, CMPIStatus *rc)
 Get a predicate in a CMPISubCond object by name. More...
 

Detailed Description

Function table of CMPISubCond encapsulated data type object.

Capabilities:
Part of the Query Normalization capability.

Field Documentation

CMPIVersion CMPISubCondFT::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(* CMPISubCondFT::release)(CMPISubCond *sc)

Release a CMPISubCond object.

CMPISubCondFT.release() releases a CMPISubCond 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
scPoints to the CMPISubCond object that is to be released. That object shall have been created using CMPISubCondFT.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_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
  • CMPI_RC_ERR_INVALID_HANDLE - The sc handle is invalid.
Convenience Function
CMRelease()
Capabilities:
Part of the Query Normalization capability.
Deprecated:
The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. If the Query Normalization capability is not available, this function cannot be called by the MI because no instance of its encapsulated data type can exist.
CMPISubCond*(* CMPISubCondFT::clone)(const CMPISubCond *sc, CMPIStatus *rc)

Create an independent copy of a CMPISubCond object.

CMPISubCondFT.clone() creates an independent copy of a CMPISubCond object.

Parameters
scPoints to the CMPISubCond object that is to be copied.
[out]rcIf 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 CMPISubCond object will be returned.

The returned CMPISubCond object shall be explicitly released by the MI using CMPISubCondFT.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_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
  • CMPI_RC_ERR_INVALID_HANDLE - The sc handle is invalid.
Convenience Function
CMClone()
Capabilities:
Part of the Query Normalization capability.
Deprecated:
The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. If the Query Normalization capability is not available, this function cannot be called by the MI because no instance of its encapsulated data type can exist.
CMPICount(* CMPISubCondFT::getCount)(const CMPISubCond *sc, CMPIStatus *rc)

Get the number of predicates in a CMPISubCond object.

CMPISubCondFT.getCount() gets the number of predicates in a CMPISubCond object.

Parameters
scPoints to the CMPISubCond object for this function.
[out]rcIf not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.
Returns

If successful, a CMPICount value indicating the number of predicates in the CMPISubCond object will be returned.

If not successful, 0 will be returned.

Errors
The function return status will indicate one of the following CMPIrc codes:
  • CMPI_RC_OK - Function successful.
  • CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
  • CMPI_RC_ERR_INVALID_HANDLE - The sc handle is invalid.
Convenience Function
CMGetPredicateCount()
Capabilities:
Part of the Query Normalization capability.
Deprecated:
The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. If the Query Normalization capability is not available, this function cannot be called by the MI because no instance of its encapsulated data type can exist.
CMPIPredicate*(* CMPISubCondFT::getPredicateAt)(const CMPISubCond *sc, CMPICount index, CMPIStatus *rc)

Get a predicate in a CMPISubCond object by index.

CMPISubCondFT.getPredicateAt() gets a predicate in a CMPISubCond object, by its index in the internal data array.

Parameters
scPoints to the CMPISubCond object for this function.
indexZero-based position of the predicate in the internal data array.
[out]rcIf 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 a CMPIPredicate object containing the specified predicate will be returned.

The returned CMPIPredicate object shall not be explicitly released by the MI, because it may be an internal object of the CMPISubCond object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

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_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
  • CMPI_RC_ERR_INVALID_HANDLE - The sc handle is invalid.
  • CMPI_RC_ERR_NO_SUCH_PROPERTY - index value out of bounds.
Convenience Function
CMGetPredicateAt()
Capabilities:
Part of the Query Normalization capability.
Deprecated:
The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. If the Query Normalization capability is not available, this function cannot be called by the MI because no instance of its encapsulated data type can exist.
CMPIPredicate*(* CMPISubCondFT::getPredicate)(const CMPISubCond *sc, const char *name, CMPIStatus *rc)

Get a predicate in a CMPISubCond object by name.

CMPISubCondFT.getPredicate() gets a predicate in a CMPISubCond object by name.

Parameters
scPoints to the CMPISubCond object for this function.
namePredicate name. The name is the left-hand side of the predicate.
[out]rcIf 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 a CMPIPredicate object containing the specified predicate will be returned.

The returned CMPIPredicate object shall not be explicitly released by the MI, because it may be an internal object of the CMPISubCond object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

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_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
  • CMPI_RC_ERR_INVALID_HANDLE - The sc handle is invalid.
  • CMPI_RC_ERR_NO_SUCH_PROPERTY - index value out of bounds.
Convenience Function
CMGetPredicate()
Capabilities:
Part of the Query Normalization capability.
Change:
In CMPI 2.1, added the return code CMPI_RC_ERR_NO_SUCH_PROPERTY.
Deprecated:
The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. If the Query Normalization capability is not available, this function cannot be called by the MI because no instance of its encapsulated data type can exist.
The documentation for this struct was generated from the following file:
Generated on Mon Oct 5 2015 14:53:29 for CMPI 2.1.0 API by   doxygen 1.8.6