Function table of CMPIObjectPath 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 )(CMPIObjectPath *op)
	Release a CMPIObjectPath object. More...

CMPIObjectPath (	clone )(const CMPIObjectPath op, CMPIStatus rc)
	Create an independent copy of a CMPIObjectPath object. More...

CMPIStatus(*	setNameSpace )(const CMPIObjectPath op, const char ns)
	Set the namespace component in a CMPIObjectPath object. More...

CMPIString (	getNameSpace )(const CMPIObjectPath op, CMPIStatus rc)
	Get the namespace component from a CMPIObjectPath object. More...

CMPIStatus(*	setHostname )(const CMPIObjectPath op, const char hn)
	Set the host name component in a CMPIObjectPath object. More...

CMPIString (	getHostname )(const CMPIObjectPath op, CMPIStatus rc)
	Get the host name component in a CMPIObjectPath object. More...

CMPIStatus(*	setClassName )(const CMPIObjectPath op, const char cn)
	Set the class name component in a CMPIObjectPath object. More...

CMPIString (	getClassName )(const CMPIObjectPath op, CMPIStatus rc)
	Get the class name component in a CIMObjectPath object. More...

CMPIStatus(*	addKey )(const CMPIObjectPath op, const char key, const CMPIValue *value, const CMPIType type)
	Add or replace a key binding in a CMPIObjectPath object by name. More...

CMPIData(*	getKey )(const CMPIObjectPath op, const char key, CMPIStatus *rc)
	Get a key binding in a CMPIObjectPath object by name. More...

CMPIData(*	getKeyAt )(const CMPIObjectPath op, CMPICount index, CMPIString name, CMPIStatus rc)
	Get a key binding in a CMPIObjectPath object by index. More...

CMPICount(*	getKeyCount )(const CMPIObjectPath op, CMPIStatus rc)
	Get the number of key bindings in a CMPIObjectPath object. More...

CMPIStatus(*	setNameSpaceFromObjectPath )(const CMPIObjectPath op, const CMPIObjectPath src)
	Set the namespace and class name components in a CMPIObjectPath object from another CMPIObjectPath object. More...

CMPIStatus(*	setHostAndNameSpaceFromObjectPath )(const CMPIObjectPath op, const CMPIObjectPath src)
	Set the host name, namespace, and class name components in a CMPIObjectPath object from another CMPIObjectPath object. More...

CMPIData(*	getClassQualifier )(const CMPIObjectPath op, const char qName, CMPIStatus *rc)
	Get a class qualifier. More...

CMPIData(*	getPropertyQualifier )(const CMPIObjectPath op, const char pName, const char qName, CMPIStatus rc)
	Get a property qualifier. More...

CMPIData(*	getMethodQualifier )(const CMPIObjectPath op, const char methodName, const char qName, CMPIStatus rc)
	Get a method qualifier. More...

CMPIData(*	getParameterQualifier )(const CMPIObjectPath op, const char mName, const char pName, const char qName, CMPIStatus *rc)
	Get a parameter qualifier. More...

CMPIString (	toString )(const CMPIObjectPath op, CMPIStatus rc)
	Convert a CMPIObjectPath object into an implementation-specific string format. More...

Detailed Description

Function table of CMPIObjectPath encapsulated data type object.

Field Documentation

CMPIVersion CMPIObjectPathFT::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(* CMPIObjectPathFT::release)(CMPIObjectPath *op)

Release a CMPIObjectPath object.

CMPIObjectPathFT.release() releases a CMPIObjectPath 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

op	Points to the CMPIObjectPath object that is to be released. That object shall have been created using CMPIObjectPathFT.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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMRelease()

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

Create an independent copy of a CMPIObjectPath object.

CMPIObjectPathFT.clone() creates an independent copy of a CMPIObjectPath object.

Parameters

	op	Points to the CMPIObjectPath 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.

Returns

If successful, a pointer to the copied CMPIObjectPath object will be returned.

The returned CMPIObjectPath object shall be explicitly released by the MI using CMPIObjectPathFT.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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMClone()

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

Set the namespace component in a CMPIObjectPath object.

CMPIObjectPathFT.setNameSpace() sets the namespace component in a CMPIObjectPath object.

Parameters

op	Points to the CMPIObjectPath object for this function.
ns	New namespace name.

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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMSetNameSpace()

Change:: In CMPI 2.1, added const-ness to op.

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

Get the namespace component from a CMPIObjectPath object.

CMPIObjectPathFT.getNameSpace() gets the namespace component from a CMPIObjectPath object.

Parameters

	op	Points to the CMPIObjectPath object for this function.
[out]	rc	If 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 CMPIString object containing the namespace component of the object path will be returned.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIObjectPath 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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMGetNameSpace()

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

Set the host name component in a CMPIObjectPath object.

CMPIObjectPathFT.setHostname() sets the host name component in a CMPIObjectPath object.

Parameters

op	Points to the CMPIObjectPath object for this function.
hn	Points to a CMPIString containing the host name.

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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMSetHostname()

Change:: In CMPI 2.1, added const-ness to op.

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

Get the host name component in a CMPIObjectPath object.

CMPIObjectPathFT.getHostname() gets the host name component in a CMPIObjectPath object.

Parameters

	op	Points to the CMPIObjectPath object for this function.
[out]	rc	If 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 CMPIString object containing the host name component of the object path will be returned.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIObjectPath 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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMGetHostname()

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

Set the class name component in a CMPIObjectPath object.

CMPIObjectPathFT.setClassName() sets the class name component in a CMPIObjectPath object.

Parameters

op	Points to the CMPIObjectPath object for this function.
cn	New class name.

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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMGetClassName()

Change:: In CMPI 2.1, added const-ness to op.

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

Get the class name component in a CIMObjectPath object.

CMPIObjectPathFT.getClassName() gets the classname component in a CMPIObjectPath object.

Parameters

	op	Points to the CMPIObjectPath object for this function.
[out]	rc	If 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 CMPIString object containing the class name component of the object path will be returned.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIObjectPath 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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMGetClassName()

CMPIStatus(* CMPIObjectPathFT::addKey)(const CMPIObjectPath *op, const char *key, const CMPIValue *value, const CMPIType type)

Add or replace a key binding in a CMPIObjectPath object by name.

CMPIObjectPathFT.addKey() adds or replaces a key binding in a CMPIObjectPath object by name.

Parameters

op	Points to the CMPIObjectPath object for this function.
key	Name of the key binding.
value	Points to a CMPIValue structure containing the value to be assigned to the key binding. Key bindings are not permitted to be NULL.
type	The type of the value to be assigned to the key binding. All types of CIM values valid for keys are supported. If the value of the type argument is CMPI_chars or CMPI_charsA, the C-language string to which the chars member of `value` points is copied by this function and the original string memory may be freed by the MI right after this function returns.

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_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_PARAMETER - key or value is invalid.

Convenience Function: CMAddKey()

Change:: In CMPI 2.1, added the return code CMPI_RC_ERR_INVALID_PARAMETER.

CMPIData(* CMPIObjectPathFT::getKey)(const CMPIObjectPath *op, const char *key, CMPIStatus *rc)

Get a key binding in a CMPIObjectPath object by name.

CMPIObjectPathFT.getKey() gets a key binding in a CMPIObjectPath object by name.

Parameters

	op	Points to the CMPIObjectPath object for this function.
	key	Name of the key binding.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIData structure containing the specified key binding will be returned.

The MB will attempt to set the type in the returned CMPIData structure to the precise CIM type, if available. Versions of the CIM-XML protocol before DSP0200 Version 1.4 did not mandate the presence of the precise CIM type. In those versions, the precise CIM type was only recommended to be present. If the precise CIM type is not available to the MB, it will use the following more general types in the returned CMPIData structure:

    #define CMPI_keyInteger   (CMPI_sint64)
    #define CMPI_keyString    (CMPI_string)
    #define CMPI_keyBoolean   (CMPI_boolean)
    #define CMPI_keyRef       (CMPI_ref)

In addition, the CMPI_keyValue flag will be set in CMPIData.state to indicate that the value is a key binding.

If not successful, CMPIData.state will be undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_NO_SUCH_PROPERTY - Key not found.

Convenience Function: CMGetKey()

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

Get a key binding in a CMPIObjectPath object by index.

CMPIObjectPathFT.getKeyAt() gets a key binding in a CMPIObjectPath object by index.

Parameters

	op	Points to the CMPIObjectPath object for this function.
	index	Zero-based position of the key binding within the internal data array.
[out]	name	Points to a CMPIString pointer that upon success will have been updated to point to a CMPIString object specifying the name of the key binding. That CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIObjectPath 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).
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIData structure containing the specified key binding will be returned.

The MB will attempt to set the type in the returned CMPIData structure to the precise CIM type, if available. Versions of the CIM-XML protocol before DSP0200 Version 1.4 did not mandate the presence of the precise CIM type. In those versions, the precise CIM type was only recommended to be present. If the precise CIM type is not available to the MB, it will use the following more general types in the returned CMPIData structure:

    #define CMPI_keyInteger   (CMPI_sint64)
    #define CMPI_keyString    (CMPI_string)
    #define CMPI_keyBoolean   (CMPI_boolean)
    #define CMPI_keyRef       (CMPI_ref)

In addition, the CMPI_keyValue flag will be set in CMPIData.state to indicate that the value is a key binding.

If not successful, CMPIData.state will be undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_NO_SUCH_PROPERTY - Key not found.

Convenience Function: CMGetKeyAt()

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

Get the number of key bindings in a CMPIObjectPath object.

CMPIObjectPathFT.getKeyCount() gets the number of key bindings in a CMPIObjectPath object.

Parameters

	op	Points to the CMPIObjectPath object for this function.
[out]	rc	If 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 key bindings will be returned. If the CMPIObjectPath object does not have a key component, the function will succeed and return 0.

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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: CMGetKeyCount()

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

Set the namespace and class name components in a CMPIObjectPath object from another CMPIObjectPath object.

CMPIObjectPathFT.setNameSpaceFromObjectPath() sets the namespace and class name components in a CMPIObjectPath object from another CMPIObjectPath object.

Parameters

op	Points to the CMPIObjectPath object for this function.
src	Points to a CMPIObjectPath object used as the source for the new namespace and class name components.

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_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_PARAMETER - src is invalid.

Convenience Function: CMSetNameSpaceFromObjectPath()

Change:: In CMPI 2.1, added the return code CMPI_RC_ERR_INVALID_PARAMETER.

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

Set the host name, namespace, and class name components in a CMPIObjectPath object from another CMPIObjectPath object.

CMPIObjectPathFT.setHostAndNameSpaceFromObjectPath() sets the host name, namespace, and class name components in a CMPIObjectPath object from another CMPIObjectPath object.

Parameters

op	Points to the CMPIObjectPath object for this function.
src	Points to a CMPIObjectPath object used as the source for the new host name, namespace, and class name components.

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_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_PARAMETER - src is invalid.

Convenience Function: CMSetHostAndNameSpaceFromObjectPath()

Change:: In CMPI 2.1, added the return code CMPI_RC_ERR_INVALID_PARAMETER.

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

Get a class qualifier.

CMPIObjectPathFT.getClassQualifier() gets a class qualifier in the class identified by this object path.

Parameters

	op	Points to a CMPIObjectPath object that references the class and that shall contain the namespace and class components. The hostname and key components, if present, will be ignored by the MB.
	qName	Qualifier name.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIData structure containing the specified qualifier will be returned.

If not successful, CMPIData.state will be undefined.

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.
CMPI_RC_ERR_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_NAMESPACE - The namespace specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_CLASS - The class specified in op is invalid or does not exist.
CMPI_RC_ERR_NOT_FOUND - The qualifier specified in qName is invalid for classes.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetClassQualifier()

Capabilities:: Part of the Basic Qualifier capability.

Change:: In CMPI 2.1, added the return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_CLASS, CMPI_RC_ERR_NOT_FOUND, and CMPI_RC_ERR_FAILED. It is believed that MB implementations needed to use these return codes already, so that their addition only fixes an omission in this standard and does not create a compatibility issue for MIs that conform to CMPI 2.0.

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

Get a property qualifier.

CMPIObjectPathFT.getPropertyQualifier() gets a property qualifier in the class identified by this object path.

Parameters

	op	Points to a CMPIObjectPath object that references the class and that shall contain the namespace and class components. The hostname and key components, if present, will be ignored by the MB.
	pName	Property name.
	qName	Qualifier name.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIData structure containing the specified qualifier will be returned.

If not successful, CMPIData.state will be undefined.

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.
CMPI_RC_ERR_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_NAMESPACE - The namespace specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_CLASS - The class specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_PARAMETER - The property (or reference) specified in pName is not exposed by the class specified in op.
CMPI_RC_ERR_NOT_FOUND - The qualifier specified in qName is invalid for properties (including references).
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetPropertyQualifier()

Capabilities:: Part of the Basic Qualifier capability.

Change:: In CMPI 2.1, added the return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_CLASS, CMPI_RC_ERR_INVALID_PARAMETER, CMPI_RC_ERR_NOT_FOUND, and CMPI_RC_ERR_FAILED. It is believed that MB implementations needed to use these return codes already, so that their addition only fixes an omission in this standard and does not create a compatibility issue for MIs that conform to CMPI 2.0.

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

Get a method qualifier.

CMPIObjectPathFT.getMethodQualifier() gets a method qualifier in the class identified by this object path.

Parameters

	op	Points to a CMPIObjectPath object that references the class and that shall contain the namespace and class components. The hostname and key components, if present, will be ignored by the MB.
	mName	Method name.
	qName	Qualifier name.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIData structure containing the specified qualifier will be returned.

If not successful, CMPIData.state will be undefined.

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.
CMPI_RC_ERR_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_NAMESPACE - The namespace specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_CLASS - The class specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_PARAMETER - The property (or reference) specified in pName is not exposed by the class specified in op.
CMPI_RC_ERR_NOT_FOUND - The qualifier specified in qName is invalid for methods.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetMethodQualifier()

Capabilities:: Part of the Basic Qualifier capability.

Change:: In CMPI 2.1, added the return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_CLASS, CMPI_RC_ERR_NOT_FOUND, and CMPI_RC_ERR_FAILED. It is believed that MB implementations needed to use these return codes already, so that their addition only fixes an omission in this standard and does not create a compatibility issue for MIs that conform to CMPI 2.0.

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

Get a parameter qualifier.

CMPIObjectPathFT.getParameterQualifier() gets a parameter qualifier in the class identified by this object path.

Parameters

	op	Points to a CMPIObjectPath object that references the class and that shall contain the namespace and class components. The hostname and key components, if present, will be ignored by the MB.
	mName	Method name.
	pName	Parameter name.
	qName	Qualifier name.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIData structure containing the specified qualifier will be returned.

If not successful, CMPIData.state will be undefined.

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.
CMPI_RC_ERR_INVALID_HANDLE - The op handle is invalid.
CMPI_RC_ERR_INVALID_NAMESPACE - The namespace specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_CLASS - The class specified in op is invalid or does not exist.
CMPI_RC_ERR_INVALID_PARAMETER - The method specified in mName is not exposed by the class specified in op, or it does not have a parameter with the name specified in pName.
CMPI_RC_ERR_NOT_FOUND - The qualifier specified in qName is invalid for parameters.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetParameterQualifier()

Capabilities:: Part of the Basic Qualifier capability.

Change:: In CMPI 2.1, added the return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_CLASS, CMPI_RC_ERR_INVALID_PARAMETER, CMPI_RC_ERR_NOT_FOUND, and CMPI_RC_ERR_FAILED. It is believed that MB implementations needed to use these return codes already, so that their addition only fixes an omission in this standard and does not create a compatibility issue for MIs that conform to CMPI 2.0.

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

Convert a CMPIObjectPath object into an implementation-specific string format.

CMPIObjectPathFT.toString() converts the object path in a CMPIObjectPath object into an MB implementation-specific string representation.

Parameters

	op	Points to the CMPIObjectPath object for this function.
[out]	rc	If 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 CMPIString object containing the string representation of the object path will be returned. The format of the string representation will vary depending on the specific MB implementation.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIObjectPath 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_INVALID_HANDLE - The op handle is invalid.

Convenience Function: None. Use CDToString() instead.

Todo:: TBD AM: This function has no directly corresponding convenience function, because it is pretty much a duplicate of CMPIBrokerEncFT.toString() when used for CMPIObjectPath objects. So the convenience function section recommends its convenience function, CDToString(). Please review.

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

cmpift.h

Data Fields

Detailed Description

Field Documentation