Function table of CMPIPropertyMI object. More...

#include <cmpift.h>

Data Fields
CMPIVersion	ftVersion
	CMPI version supported by the MI for this function table. More...

int	miVersion
	Informal MI-specific version number for this MI.

const char *	miName
	Informal MI-specific name for this MI.

CMPIStatus(*	cleanup )(CMPIPropertyMI mi, const CMPIContext ctx, CMPIBoolean terminating)
	Perform cleanup for a Property MI. (Deprecated) More...

CMPIStatus(*	setProperty )(CMPIPropertyMI mi, const CMPIContext ctx, const CMPIResult rslt, const CMPIObjectPath instPath, const char *name, const CMPIData data)
	Set the value of a property of an existing instance. (Deprecated) More...

CMPIStatus(*	getProperty )(CMPIPropertyMI mi, const CMPIContext ctx, const CMPIResult rslt, const CMPIObjectPath instPath, const char *name)
	Retrieve a property value of an existing instance. (Deprecated) More...

CMPIStatus(*	setPropertyWithOrigin )(CMPIPropertyMI mi, const CMPIContext ctx, const CMPIResult rslt, CMPIObjectPath instPath, const char name, const CMPIData data, const char origin)
	Set the value and origin of a property of an existing instance. (Deprecated) More...

Detailed Description

Function table of CMPIPropertyMI object.

Addition:: Added in CMPI 2.0.

Field Documentation

CMPIVersion CMPIPropertyMIFT::ftVersion

CMPI version supported by the MI for this function table.

Any later CMPI versions are implicitly also supported.

See CMPIVersion<NNN> for valid CMPI version numbers.

CMPIStatus(* CMPIPropertyMIFT::cleanup)(CMPIPropertyMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)

Perform cleanup for a Property MI. (Deprecated)

CMPIPropertyMIFT.cleanup() shall perform any necessary cleanup for the Property MI identified by mi, unless the MI postpones the cleanup.

While this function executes, the MB will not call any other MI functions for this MI. This function will be called once for a specific MI (unless the MI postpones the cleanup), even if that MI services more than one namespace. After this function returns, the MB may unload the load library this MI is part of, unless the MI postpones the cleanup.

Parameters

mi Points to a CMPIPropertyMI structure.

ctx Points to a CMPIContext object containing the context data for the invocation. The context data entries are MB implementation-specific.

terminating

Indicates whether the MB is in the process of shutting down and thus cannot tolerate postponing of the cleanup, as follows:

When True, the MB is in the process of shutting down. The MI shall perform any necessary cleanup and shall not postpone the cleanup. After this function returns (successful or in error), the MB will consider this MI to be uninitialized and will not call further MI functions for this MI.

When False, the MI can choose to perform or postpone the cleanup, by performing one of these actions:

The MI performs any necessary cleanup and does not request postponing the cleanup. After this function returns (successful or in error), the MB will consider this MI to be uninitialized and will not call further MI functions for this MI.
The MI does not perform any cleanup and temporarily postpones the cleanup, by returning CMPI_RC_DO_NOT_UNLOAD. This will cause the MB to consider this MI still to be initialized, and the MB may call further MI functions of this MI. The MB may call this function again after some MB implementation-specific time.
The MI does not perform any cleanup and permanently postpones the cleanup, by returning CMPI_RC_NEVER_UNLOAD. This will cause the MB to consider this MI still to be initialized, and the MB may call further MI functions of this MI. The MB will not call this function again until the MB terminates (at which time the MB calls this function with terminating set to true).

Returns: CMPIStatus structure containing the function return status.

Errors

The following CMPIrc codes shall be used by the MI in the function return status:

CMPI_RC_OK - Function successful.
CMPI_RC_DO_NOT_UNLOAD - Function successful, do not unload now; the MB may retry an unload later.
CMPI_RC_NEVER_UNLOAD - Function successful, never unload; the MB will not retry an unload later unless it shuts down.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMPropertyMIStub()

Addition:: Added in CMPI 2.0.

Deprecated:: This function is deprecated since CMPI 2.1, in accord with the deprecation of property client operations in DMTF specifications.

Bug:: The CMPI Standard is not specific about the number of invocations of this function when an MI services more than one namespace. It should be updated to state that the function is invoked only once, even if the MI services more than one namespace.

CMPIStatus(* CMPIPropertyMIFT::setProperty)(CMPIPropertyMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *instPath, const char *name, const CMPIData data)

Set the value of a property of an existing instance. (Deprecated)

CMPIPropertyMIFT.setProperty() shall set the value of a property of an existing instance, by accessing the underlying managed elements.

This function is provided by the MI in context of a particular MI name. The class of instPath for which this function will be called by the MB depends on the specifics of how the MB relates classes and MI names, which is out of scope for this standard. As a result, the MB may call this function for classes for which the MI is not responsible. In order for an MI to be portable across MB implementations with different approaches to relate MI names and classes, the MI must check whether it services the class specified in instPath.

Parameters

mi	Points to a CMPIPropertyMI structure.
ctx	Points to a CMPIContext object containing the context data for the invocation.
rslt	Points to a CMPIResult object that is the result data container. Upon successful return, the MI shall have left this container empty.
instPath	Points to a CMPIObjectPath object that references the instance to be modified and that contains the namespace, class name, and key components. The hostname component, if present, has no meaning and should be ignored.
name	Property name.
data	A CMPIData structure specifying the value to be assigned to the property.

Returns: CMPIStatus structure containing the function return status.

Errors

The following table lists the CMPIrc codes that shall be used by the MI in the function return status, as well as the WBEM operation messages that should be used in the CMPIError object if the MI supports extended error handling (see the corresponding Extended Errors capability):

CMPIRCCode	CMPIErrorMsg	Description
`CMPI_RC_OK`	N/A	Function Successful.
`CMPI_RC_ERR_NOT_SUPPORTED`	WIPG0228	Function is not supported by the MB.
`CMPI_RC_ERR_ACCESS_DENIED`	WIPG0201	Not authorized.
`CMPI_RC_ERR_INVALID_NAMESPACE`	N/A	The namespace specified in `instPath` is invalid or does not exist. (Deprecated)
`CMPI_RC_ERR_INVALID_PARAMETER`	N/A	The parameter is invalid. (Deprecated)
`CMPI_RC_ERR_INVALID_CLASS`	N/A	The class specified in `instPath` is invalid or does not exist. (Deprecated)
`CMPI_RC_ERR_NOT_FOUND`	WIPG0213	Instance not found.
`CMPI_RC_ERR_NO_SUCH_PROPERTY`	WIPG0220	No such property.
`CMPI_RC_ERR_FAILED`	WIPG0243	Timeout occurred.
`CMPI_RC_ERR_FAILED`	WIPG0227 + implementation-specific message	Other error occurred.

Convenience Function: CMPropertyMIStub()

Addition:: Added in CMPI 2.0.

Deprecated:

The return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_PARAMETER, and CMPI_RC_ERR_INVALID_CLASS for this function are deprecated since CMPI 2.1, because the corresponding conditions have already been verified by the MB.

This function is deprecated since CMPI 2.1, in accord with the deprecation of property client operations in DMTF specifications.

CMPIStatus(* CMPIPropertyMIFT::getProperty)(CMPIPropertyMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *instPath, const char *name)

Retrieve a property value of an existing instance. (Deprecated)

CMPIPropertyMIFT.getProperty() shall retrieve a property value of an existing instance, by accessing the underlying managed elements.

Parameters

mi	Points to a CMPIPropertyMI structure.
ctx	Points to a CMPIContext object containing the context data for the invocation.
rslt	Points to a CMPIResult object that is the result data container. Upon successful return, the MI shall have put the retrieved property value into this container. The CMPIResultFT function to be used for that depends on the data type of the property, as follows: The values of properties declared as embedded instances (see Subclause 4.1.3 of the CMPI Standard) shall be returned using CMPIResultFT.returnInstance(). The values of references (see Subclause 4.1.3 of the CMPI Standard) shall be returned using CMPIResultFT.returnObjectPath(). Any other property values shall be returned using CMPIResultFT.returnData().
instPath	Points to a CMPIObjectPath object that references the given instance and that contains the namespace, class name, and key components. The hostname component, if present, has no meaning and should be ignored.
name	Property name.

Returns: CMPIStatus structure containing the function return status.

Errors

The following table lists the CMPIrc codes that shall be used by the MI in the function return status, as well as the WBEM operation messages that should be used in the CMPIError object if the MI supports extended error handling (see the corresponding Extended Errors capability):

CMPIRCCode	CMPIErrorMsg	Description
`CMPI_RC_OK`	N/A	Function Successful.
`CMPI_RC_ERR_NOT_SUPPORTED`	WIPG0228	Function is not supported by the MB.
`CMPI_RC_ERR_ACCESS_DENIED`	WIPG0201	Not authorized.
`CMPI_RC_ERR_INVALID_NAMESPACE`	N/A	The namespace specified in `instPath` is invalid or does not exist. (Deprecated)
`CMPI_RC_ERR_INVALID_PARAMETER`	N/A	The parameter is invalid. (Deprecated)
`CMPI_RC_ERR_INVALID_CLASS`	N/A	The class specified in `instPath` is invalid or does not exist. (Deprecated)
`CMPI_RC_ERR_NOT_FOUND`	WIPG0213	Instance not found.
`CMPI_RC_ERR_NO_SUCH_PROPERTY`	WIPG0220	No such property.
`CMPI_RC_ERR_FAILED`	WIPG0243	Timeout occurred.
`CMPI_RC_ERR_FAILED`	WIPG0227 + implementation-specific message	Other error occurred.

Convenience Function: CMPropertyMIStub()

Addition:: Added in CMPI 2.0.

Deprecated:

The return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_PARAMETER, and CMPI_RC_ERR_INVALID_CLASS for this function are deprecated since CMPI 2.1, because the corresponding conditions have already been verified by the MB.

This function is deprecated since CMPI 2.1, in accord with the deprecation of property client operations in DMTF specifications.

CMPIStatus(* CMPIPropertyMIFT::setPropertyWithOrigin)(CMPIPropertyMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, CMPIObjectPath *instPath, const char *name, const CMPIData data, const char *origin)

Set the value and origin of a property of an existing instance. (Deprecated)

CMPIPropertyMIFT.setPropertyWithOrigin() shall set the value and origin of a property of an existing instance, by accessing the underlying managed elements.

This function is provided by the MI in context of a particular MI name. The class of instPath for which this function will be called by the MB depends on the specifics of how the MB relates classes and MI names, which is out of scope for this standard. As a result, the MB may call this function for classes for which the MI is not responsible. In order for an MI to be portable across MB implementations with different approaches to relate MI names and classes, the MI must check whether it services the class specified in instPath.

Parameters

mi	Points to a CMPIPropertyMI structure.
ctx	Points to a CMPIContext object containing the context data for the invocation.
rslt	Points to a CMPIResult object that is the result data container. Upon successful return, the MI shall have left this container empty.
instPath	Points to a CMPIObjectPath object that references the instance to be retrieved and that contains the namespace, class name, and key components. The hostname component, if present, has no meaning and should be ignored.
name	Property name.
data	A CMPIData structure specifying the value to be assigned to the property.
origin	Origin (class name) to be set for the property. If NULL, no origin is set for the property.

Returns: CMPIStatus structure containing the function return status.

Errors

The following table lists the CMPIrc codes that shall be used by the MI in the function return status, as well as the WBEM operation messages that should be used in the CMPIError object if the MI supports extended error handling (see the corresponding Extended Errors capability):

CMPIRCCode	CMPIErrorMsg	Description
`CMPI_RC_OK`	N/A	Function Successful.
`CMPI_RC_ERR_NOT_SUPPORTED`	WIPG0228	Function is not supported by the MB.
`CMPI_RC_ERR_ACCESS_DENIED`	WIPG0201	Not authorized.
`CMPI_RC_ERR_INVALID_NAMESPACE`	N/A	The namespace specified in `instPath` is invalid or does not exist. (Deprecated)
`CMPI_RC_ERR_INVALID_PARAMETER`	N/A	The parameter is invalid. (Deprecated)
`CMPI_RC_ERR_INVALID_CLASS`	N/A	The class specified in `instPath` is invalid or does not exist. (Deprecated)
`CMPI_RC_ERR_NOT_FOUND`	WIPG0213	Instance not found.
`CMPI_RC_ERR_NO_SUCH_PROPERTY`	WIPG0220	No such property.
`CMPI_RC_ERR_FAILED`	WIPG0243	Timeout occurred.
`CMPI_RC_ERR_FAILED`	WIPG0227 + implementation-specific message	Other error occurred.

Convenience Function: CMPropertyMIStub()

Addition:: Added in CMPI 2.0.

Deprecated:

The return codes CMPI_RC_ERR_INVALID_NAMESPACE, CMPI_RC_ERR_INVALID_PARAMETER, and CMPI_RC_ERR_INVALID_CLASS for this function are deprecated since CMPI 2.1, because the corresponding conditions have already been verified by the MB.

This function is deprecated since CMPI 2.1, in accord with the deprecation of property client operations in DMTF specifications.

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

cmpift.h

Data Fields

Detailed Description

Field Documentation