|
CMPI 2.1.0 API
|
|
CMPI 2.1.0 API
|
Function table of CMPISelectCond 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 )(CMPISelectCond *sc) |
| Release a CMPISelectCond object. More... | |
| CMPISelectCond *(* | clone )(const CMPISelectCond *sc, CMPIStatus *rc) |
| Create an independent copy of a CMPISelectCond object. More... | |
| CMPICount(* | getCountAndType )(const CMPISelectCond *sc, int *type, CMPIStatus *rc) |
| Get the number and type of subconditions in a CMPISelectCond object. More... | |
| CMPISubCond *(* | getSubCondAt )(const CMPISelectCond *sc, CMPICount index, CMPIStatus *rc) |
| Get a subcondition in a CMPISelectCond object by index. More... | |
Function table of CMPISelectCond encapsulated data type object.
| CMPIVersion CMPISelectCondFT::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(* CMPISelectCondFT::release)(CMPISelectCond *sc) |
Release a CMPISelectCond object.
CMPISelectCondFT.release() releases a CMPISelectCond 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).
| sc | Points to the CMPISelectCond object that is to be released. That object shall have been created using CMPISelectCondFT.clone(). |
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_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. | CMPISelectCond*(* CMPISelectCondFT::clone)(const CMPISelectCond *sc, CMPIStatus *rc) |
Create an independent copy of a CMPISelectCond object.
CMPISelectCondFT.clone() creates an independent copy of a CMPISelectCond object.
| sc | Points to the CMPISelectCond 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. |
If successful, a pointer to the copied CMPISelectCond object will be returned.
The returned CMPISelectCond object shall be explicitly released by the MI using CMPISelectCondFT.release().
If not successful, NULL will be returned.
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_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(* CMPISelectCondFT::getCountAndType)(const CMPISelectCond *sc, int *type, CMPIStatus *rc) |
Get the number and type of subconditions in a CMPISelectCond object.
CMPISelectCondFT.getCountAndType() gets the number and type of the subconditions in a CMPISelectCond object.
| sc | Points to the CMPISelectCond object for this function. | |
| [out] | type | If not NULL, points to an integer that upon success is updated with the subcondition type. A value of 0 indicates a DOC type, and a value of 1 indicates a COD type. If type is NULL, no type information is returned. |
| [out] | rc | If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status. |
If successful, a CMPICount value indicating the number of subconditions will be returned.
If not successful, 0 will be returned.
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_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*(* CMPISelectCondFT::getSubCondAt)(const CMPISelectCond *sc, CMPICount index, CMPIStatus *rc) |
Get a subcondition in a CMPISelectCond object by index.
CMPISelectCondFT.getSubCondAt() gets the subcondition in a CMPISelectCond object, by its index in the internal data array.
| sc | Points to the CMPISelectCond object for this function. | |
| index | Zero-based position of the subcondition in the internal data array. | |
| [out] | rc | If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status. |
If successful, a pointer to the specified CMPISubCond object will be returned.
The returned CMPISubCond object shall not be explicitly released by the MI, because it may be an internal object of the CMPISelectCond 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.
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.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. 
1.8.6