cmpi
_CMPIObjectPathFT Struct Reference

#include <cmpi/cmpift.h>

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

◆ addKey

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

Adds/replaces a named key property.

Parameters
opObjectPath this pointer.
nameKey property name.
valueAddress of value structure.
typeValue type.
Returns
Service return status.

Referenced by CmpiObjectPath::setKey().

◆ clone

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

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

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

◆ ftVersion

int _CMPIObjectPathFT::ftVersion

Function table version

◆ getClassName

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

Get the classname component.

Parameters
opObjectPath this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
The classname component.

Referenced by CmpiObjectPath::getClassName().

◆ getClassQualifier

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

Get class qualifier value.

Parameters
opObjectPath this pointer.
qNameQualifier name.
rcOutput: Service return status (suppressed when NULL).
Returns
Qualifier value.

◆ getHostname

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

Get the hostname component.

Parameters
opObjectPath this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
The hostname component.

Referenced by CmpiObjectPath::getHostname().

◆ getKey

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

Gets a named key property value.

Parameters
opObjectPath this pointer.
nameKey property name.
rcOutput: Service return status (suppressed when NULL).
Returns
Entry value.

Referenced by CmpiObjectPath::getKey().

◆ getKeyAt

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

Gets a key property value defined by its index.

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

Referenced by CmpiObjectPath::getKey().

◆ getKeyCount

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

Gets the number of key properties contained in this ObjectPath.

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

Referenced by CmpiObjectPath::getKeyCount().

◆ getMethodQualifier

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

Get method qualifier value.

Parameters
opObjectPath this pointer.
mNameMethod name.
qNameQualifier name.
rcOutput: Service return status (suppressed when NULL).
Returns
Qualifier value.

◆ getNameSpace

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

Get the namespace component.

Parameters
opObjectPath this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
The namespace component.

Referenced by CmpiObjectPath::getNameSpace().

◆ getParameterQualifier

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

Get method parameter quailifier value.

Parameters
opObjectPath this pointer.
mNameMethod name.
pNameParameter name.
qNameQualifier name.
rcOutput: Service return status (suppressed when NULL).
Returns
Qualifier value.

◆ getPropertyQualifier

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

Get property qualifier value.

Parameters
opObjectPath this pointer.
pNameProperty name.
qNameQualifier name.
rcOutput: Service return status (suppressed when NULL).
Returns
Qualifier value.

◆ release

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

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

Parameters
opObjectPath this pointer.
Returns
Service return status.

◆ setClassName

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

Set/replace the classname component.

Parameters
opObjectPath this pointer.
cnThe hostname string
Returns
Service return status.

Referenced by CmpiObjectPath::setClassName().

◆ setHostAndNameSpaceFromObjectPath

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

Set/replace hostname, namespace and classname components from <src>.

Parameters
opObjectPath this pointer.
srcSource input.
Returns
Service return status.

◆ setHostname

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

Set/replace the hostname component.

Parameters
opObjectPath this pointer.
hnThe hostname string
Returns
Service return status.

Referenced by CmpiObjectPath::setHostname().

◆ setNameSpace

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

Set/replace the namespace component.

Parameters
opObjectPath this pointer.
nsThe namespace string
Returns
Service return status.

Referenced by CmpiObjectPath::setNameSpace().

◆ setNameSpaceFromObjectPath

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

Set/replace namespace and classname components from <src>.

Parameters
opObjectPath this pointer.
srcSource input.
Returns
Service return status.

◆ toString

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

Generates a well formed string representation of this ObjectPath

Parameters
opObjectPath this pointer.
rcOutput: Service return status (suppressed when NULL).
Returns
String representation.

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