cmpi
Public Attributes | List of all members
_CMPIPropertyMIFT Struct Reference

#include <cmpi/cmpift.h>

Public Attributes

int ftVersion
 
int miVersion
 
const char * miName
 
CMPIStatus(* cleanup )(CMPIPropertyMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)
 
CMPIStatus(* setProperty )(CMPIPropertyMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *name, const CMPIData data)
 
CMPIStatus(* getProperty )(CMPIPropertyMI *, const CMPIContext *, const CMPIResult *, const CMPIObjectPath *, const char *name)
 
CMPIStatus(* setPropertyWithOrigin )(CMPIPropertyMI *, const CMPIContext *, const CMPIResult *, CMPIObjectPath *op, const char *name, const CMPIData data, const char *)
 

Detailed Description

This structure is a table of pointers providing access to Property provider functions. This table must be returend during initialization by the provider.

Member Data Documentation

◆ cleanup

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

Cleanup is called prior to unloading of the provider.

Parameters
miProvider this pointer.
ctxInvocation Context
terminatingWhen true, the terminating argument indicates that the MB is in the process of terminating and that cleanup must be done. When set to false, the MI may respond with CMPI_IRC_DO_NOT_UNLOAD, or CMPI_IRC_NEVER_UNLOAD, indicating that unload will interfere with current MI processing.
Returns
Function return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_DO_NOT_UNLOAD Operation successful - do not unload now. CMPI_RC_NEVER_UNLOAD Operation successful - never unload.

◆ ftVersion

int _CMPIPropertyMIFT::ftVersion

Function table version

◆ getProperty

CMPIStatus(* _CMPIPropertyMIFT::getProperty) (CMPIPropertyMI *, const CMPIContext *, const CMPIResult *, const CMPIObjectPath *, const char *name)

Get the named property value of an Instance defined by the <op> parameter.

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opObjectPath containing namespace, classname and key components.
nameProperty name
Returns
Function return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_FAILED Unspecific error occurred. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_INVALID_NAMESPACE The namespace is invalid. CMPI_RC_ERR_INVALID_PARAMETER The parameter is invalid. CMPI_RC_ERR_INVALID_CLASS The CIM class does not exist in the specified namespace. CMPI_RC_ERR_NOT_FOUND Instance not found. CMPI_RC_ERR_NO_SUCH_PROPERTY Entry not found.

◆ miName

const char* _CMPIPropertyMIFT::miName

Provider name

◆ miVersion

int _CMPIPropertyMIFT::miVersion

Provider version

◆ setProperty

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

Set the named property value of an Instance defined by the <op> parameter.

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opObjectPath containing namespace, classname and key components.
nameProperty name
dataProperty value.
Returns
Function return status. The following CMPIrc codes shall be recognized: CMPI_RC_OK Operation successful. CMPI_RC_ERR_TYPE_MISATCH type does not correspond to class-defined type. CMPI_RC_ERR_INVALID_HANDLE The inst handle is invalid.

◆ setPropertyWithOrigin

CMPIStatus(* _CMPIPropertyMIFT::setPropertyWithOrigin) (CMPIPropertyMI *, const CMPIContext *, const CMPIResult *, CMPIObjectPath *op, const char *name, const CMPIData data, const char *)

add/replace a named Property value and origin

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opObjectPath containing namespace, classname and key components
nameProperty name
dataProperty 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: