cmpi
Public Attributes | List of all members
_CMPIInstanceFT Struct Reference

#include <cmpi/cmpift.h>

Public Attributes

int ftVersion
 
CMPIStatus(* release )(CMPIInstance *inst)
 
CMPIInstance *(* clone )(const CMPIInstance *inst, CMPIStatus *rc)
 
CMPIData(* getProperty )(const CMPIInstance *inst, const char *name, CMPIStatus *rc)
 
CMPIData(* getPropertyAt )(const CMPIInstance *inst, CMPICount index, CMPIString **name, CMPIStatus *rc)
 
CMPICount(* getPropertyCount )(const CMPIInstance *inst, CMPIStatus *rc)
 
CMPIStatus(* setProperty )(const CMPIInstance *inst, const char *name, const CMPIValue *value, CMPIType type)
 
CMPIObjectPath *(* getObjectPath )(const CMPIInstance *inst, CMPIStatus *rc)
 
CMPIStatus(* setPropertyFilter )(CMPIInstance *inst, const char **propertyList, const char **keys)
 
CMPIStatus(* setObjectPath )(CMPIInstance *inst, const CMPIObjectPath *op)
 
CMPIStatus(* setPropertyWithOrigin )(const CMPIInstance *, const char *, const CMPIValue *, const CMPIType, const char *)
 

Detailed Description

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

Member Data Documentation

◆ clone

CMPIInstance*(* _CMPIInstanceFT::clone) (const CMPIInstance *inst, CMPIStatus *rc)

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

Parameters
instInstance this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
Pointer to copied Instance object.

◆ ftVersion

int _CMPIInstanceFT::ftVersion

Function table version

◆ getObjectPath

CMPIObjectPath*(* _CMPIInstanceFT::getObjectPath) (const CMPIInstance *inst, CMPIStatus *rc)

Generates an ObjectPath out of the namespace, classname and key propeties of this Instance.

Parameters
instInstance this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
the generated ObjectPath.

◆ getProperty

CMPIData(* _CMPIInstanceFT::getProperty) (const CMPIInstance *inst, const char *name, CMPIStatus *rc)

Gets a named property value.

Parameters
instInstance this pointer.
nameProperty name.
rcOutput: Service return status (suppressed when NULL).
Returns
Property value.

Referenced by CmpiInstance::getProperty().

◆ getPropertyAt

CMPIData(* _CMPIInstanceFT::getPropertyAt) (const CMPIInstance *inst, CMPICount index, CMPIString **name, CMPIStatus *rc)

Gets a Property value defined by its index.

Parameters
instInstance this pointer.
indexPosition in the internal Data array.
nameOutput: Returned property name (suppressed when NULL).
rcOutput: Service return status (suppressed when NULL).
Returns
Property value.

Referenced by CmpiInstance::getProperty().

◆ getPropertyCount

CMPICount(* _CMPIInstanceFT::getPropertyCount) (const CMPIInstance *inst, CMPIStatus *rc)

Gets the number of properties contained in this Instance.

Parameters
instInstance this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
Number of properties.

Referenced by CmpiInstance::getPropertyCount().

◆ release

CMPIStatus(* _CMPIInstanceFT::release) (CMPIInstance *inst)

The Instance object will not be used any further and may be freed by CMPI run time system. This will also release the contained objects.

Parameters
instInstance this pointer.
Returns
Service return status.

◆ setObjectPath

CMPIStatus(* _CMPIInstanceFT::setObjectPath) (CMPIInstance *inst, const CMPIObjectPath *op)

Set/replace the ObjectPath component in an instance.

Parameters
instThe CMPIInstance structure containing a complete instance. op The CMPIObjectPath structure. This objectpath shall contain the namespace,classname, as well as all keys for the specified instance.
Returns
Service return status.

◆ setProperty

CMPIStatus(* _CMPIInstanceFT::setProperty) (const CMPIInstance *inst, const char *name, const CMPIValue *value, CMPIType type)

Adds/replaces a named Property.

Parameters
instInstance this pointer.
nameEntry name.
valueAddress of value structure.
typeValue type.
Returns
Service return status.

Referenced by CmpiInstance::setProperty().

◆ setPropertyFilter

CMPIStatus(* _CMPIInstanceFT::setPropertyFilter) (CMPIInstance *inst, const char **propertyList, const char **keys)

Directs CMPI to ignore any setProperty operations for this instance for any properties not in this list.

Parameters
instInstance this pointer.
propertyListIf not NULL, the members of the array define one or more Property names to be accepted by setProperty operations.
keysDeprecated, ignored by MB, maintained here for compatibility.
Returns
Service return status.

Referenced by CmpiInstance::setPropertyFilter().

◆ setPropertyWithOrigin

CMPIStatus(* _CMPIInstanceFT::setPropertyWithOrigin) (const CMPIInstance *, const char *, const CMPIValue *, const CMPIType, const char *)

add/replace a named Property value and origin

Parameters
instis a pointer to the CMPIInstance structure.
nameis a string containing the Property name.
valuepoints to a CMPIValue structure containing the value to be assigned to the Property.
typeis a CMPIType structure defining the type of the value.
originspecifies the instance origin. If NULL, then no origin is attached to the property
Returns
Service return status

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