_CMPIObjectPathFT Struct Reference

#include <cmpi/cmpift.h>

List of all members.

Public Attributes
int	ftVersion
CMPIStatus(*	release )(CMPIObjectPath *op)
CMPIObjectPath *(*	clone )(const CMPIObjectPath *op, CMPIStatus *rc)
CMPIStatus(*	setNameSpace )(CMPIObjectPath *op, const char *ns)
CMPIString *(*	getNameSpace )(const CMPIObjectPath *op, CMPIStatus *rc)
CMPIStatus(*	setHostname )(CMPIObjectPath *op, const char *hn)
CMPIString *(*	getHostname )(const CMPIObjectPath *op, CMPIStatus *rc)
CMPIStatus(*	setClassName )(CMPIObjectPath *op, const char *cn)
CMPIString *(*	getClassName )(const CMPIObjectPath *op, CMPIStatus *rc)
CMPIStatus(*	addKey )(CMPIObjectPath *op, const char *name, const CMPIValue *value, const CMPIType type)
CMPIData(*	getKey )(const CMPIObjectPath *op, const char *name, CMPIStatus *rc)
CMPIData(*	getKeyAt )(const CMPIObjectPath *op, CMPICount index, CMPIString **name, CMPIStatus *rc)
CMPICount(*	getKeyCount )(const CMPIObjectPath *op, CMPIStatus *rc)
CMPIStatus(*	setNameSpaceFromObjectPath )(CMPIObjectPath *op, const CMPIObjectPath *src)
CMPIStatus(*	setHostAndNameSpaceFromObjectPath )(CMPIObjectPath *op, const CMPIObjectPath *src)
CMPIData(*	getClassQualifier )(const CMPIObjectPath *op, const char *qName, CMPIStatus *rc)
CMPIData(*	getPropertyQualifier )(const CMPIObjectPath *op, const char *pName, const char *qName, CMPIStatus *rc)
CMPIData(*	getMethodQualifier )(const CMPIObjectPath *op, const char *methodName, const char *qName, CMPIStatus *rc)
CMPIData(*	getParameterQualifier )(const CMPIObjectPath *op, const char *mName, const char *pName, const char *qName, CMPIStatus *rc)
CMPIString *(*	toString )(const CMPIObjectPath *op, CMPIStatus *rc)

---

Detailed Description

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

---

Member Data Documentation

CMPIStatus(* _CMPIObjectPathFT::addKey)(CMPIObjectPath *op, const char *name, const CMPIValue *value, const CMPIType type)

Adds/replaces a named key property. Parameters: op  ObjectPath this pointer. name  Key property name. value  Address of value structure. type  Value type. Returns: Service return status.

CMPIObjectPath*(* _CMPIObjectPathFT::clone)(const CMPIObjectPath *op, CMPIStatus *rc)

Create an independent copy of this ObjectPath object. The resulting object must be released explicitly. Parameters: op  ObjectPath this pointer. rc  Output: Service return status (suppressed when NULL). Returns: Pointer to copied ObjectPath object.

int _CMPIObjectPathFT::ftVersion

Function table version

CMPIString*(* _CMPIObjectPathFT::getClassName)(const CMPIObjectPath *op, CMPIStatus *rc)

Get the classname component. Parameters: op  ObjectPath this pointer. rc  Output: Service return status (suppressed when NULL). Returns: The classname component.

CMPIData(* _CMPIObjectPathFT::getClassQualifier)(const CMPIObjectPath *op, const char *qName, CMPIStatus *rc)

Get class qualifier value. Parameters: op  ObjectPath this pointer. qName  Qualifier name. rc  Output: Service return status (suppressed when NULL). Returns: Qualifier value.

CMPIString*(* _CMPIObjectPathFT::getHostname)(const CMPIObjectPath *op, CMPIStatus *rc)

Get the hostname component. Parameters: op  ObjectPath this pointer. rc  Output: Service return status (suppressed when NULL). Returns: The hostname component.

CMPIData(* _CMPIObjectPathFT::getKey)(const CMPIObjectPath *op, const char *name, CMPIStatus *rc)

Gets a named key property value. Parameters: op  ObjectPath this pointer. name  Key property name. rc  Output: Service return status (suppressed when NULL). Returns: Entry value.

CMPIData(* _CMPIObjectPathFT::getKeyAt)(const CMPIObjectPath *op, CMPICount index, CMPIString **name, CMPIStatus *rc)

Gets a key property value defined by its index. Parameters: op  ObjectPath this pointer. index  Position in the internal Data array. name  Output: Returned property name (suppressed when NULL). rc  Output: Service return status (suppressed when NULL). Returns: Data value.

CMPICount(* _CMPIObjectPathFT::getKeyCount)(const CMPIObjectPath *op, CMPIStatus *rc)

Gets the number of key properties contained in this ObjectPath. Parameters: op  ObjectPath this pointer. rc  Output: Service return status (suppressed when NULL). Returns: Number of properties.

CMPIData(* _CMPIObjectPathFT::getMethodQualifier)(const CMPIObjectPath *op, const char *methodName, const char *qName, CMPIStatus *rc)

Get method qualifier value. Parameters: op  ObjectPath this pointer. mName  Method name. qName  Qualifier name. rc  Output: Service return status (suppressed when NULL). Returns: Qualifier value.

CMPIString*(* _CMPIObjectPathFT::getNameSpace)(const CMPIObjectPath *op, CMPIStatus *rc)

Get the namespace component. Parameters: op  ObjectPath this pointer. rc  Output: Service return status (suppressed when NULL). Returns: The namespace component.

CMPIData(* _CMPIObjectPathFT::getParameterQualifier)(const CMPIObjectPath *op, const char *mName, const char *pName, const char *qName, CMPIStatus *rc)

Get method parameter quailifier value. Parameters: op  ObjectPath this pointer. mName  Method name. pName  Parameter name. qName  Qualifier name. rc  Output: Service return status (suppressed when NULL). Returns: Qualifier value.

CMPIData(* _CMPIObjectPathFT::getPropertyQualifier)(const CMPIObjectPath *op, const char *pName, const char *qName, CMPIStatus *rc)

Get property qualifier value. Parameters: op  ObjectPath this pointer. pName  Property name. qName  Qualifier name. rc  Output: Service return status (suppressed when NULL). Returns: Qualifier value.

CMPIStatus(* _CMPIObjectPathFT::release)(CMPIObjectPath *op)

The ObjectPath object will not be used any further and may be freed by CMPI run time system. Parameters: op  ObjectPath this pointer. Returns: Service return status.

CMPIStatus(* _CMPIObjectPathFT::setClassName)(CMPIObjectPath *op, const char *cn)

Set/replace the classname component. Parameters: op  ObjectPath this pointer. cn  The hostname string Returns: Service return status.

CMPIStatus(* _CMPIObjectPathFT::setHostAndNameSpaceFromObjectPath)(CMPIObjectPath *op, const CMPIObjectPath *src)

Set/replace hostname, namespace and classname components from <src>. Parameters: op  ObjectPath this pointer. src  Source input. Returns: Service return status.

CMPIStatus(* _CMPIObjectPathFT::setHostname)(CMPIObjectPath *op, const char *hn)

Set/replace the hostname component. Parameters: op  ObjectPath this pointer. hn  The hostname string Returns: Service return status.

CMPIStatus(* _CMPIObjectPathFT::setNameSpace)(CMPIObjectPath *op, const char *ns)

Set/replace the namespace component. Parameters: op  ObjectPath this pointer. ns  The namespace string Returns: Service return status.

CMPIStatus(* _CMPIObjectPathFT::setNameSpaceFromObjectPath)(CMPIObjectPath *op, const CMPIObjectPath *src)

Set/replace namespace and classname components from <src>. Parameters: op  ObjectPath this pointer. src  Source input. Returns: Service return status.

CMPIString*(* _CMPIObjectPathFT::toString)(const CMPIObjectPath *op, CMPIStatus *rc)

Generates a well formed string representation of this ObjectPath Parameters: op  ObjectPath this pointer. rc  Output: Service return status (suppressed when NULL). Returns: String representation.

---

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

• cmpi/cmpift.h

---