cmpi
Public Attributes | List of all members
_CMPIAssociationMIFT Struct Reference

#include <cmpi/cmpift.h>

Public Attributes

int ftVersion
 
const CMPISint32 miVersion
 
const char * miName
 
CMPIStatus(* cleanup )(CMPIAssociationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)
 
CMPIStatus(* associators )(CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *asscClass, const char *resultClass, const char *role, const char *resultRole, const char **properties)
 
CMPIStatus(* associatorNames )(CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole)
 
CMPIStatus(* references )(CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *resultClass, const char *role, const char **properties)
 
CMPIStatus(* referenceNames )(CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *resultClass, const char *role)
 

Detailed Description

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

Member Data Documentation

◆ associatorNames

CMPIStatus(* _CMPIAssociationMIFT::associatorNames) (CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole)

Enumerate ObjectPaths associated with the Instance defined by <op>.

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opSource ObjectPath containing namespace, classname and key components.
assocClassIf not NULL, MUST be a valid Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClassIf not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
roleIf not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRoleIf not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).
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_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_NOT_FOUND Instance not found.

◆ associators

CMPIStatus(* _CMPIAssociationMIFT::associators) (CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *asscClass, const char *resultClass, const char *role, const char *resultRole, const char **properties)

Enumerate ObjectPaths associated with the Instance defined by <op>.

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opSource ObjectPath containing namespace, classname and key components.
assocClassIf not NULL, MUST be a valid Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClassIf not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
roleIf not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRoleIf not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to
propertiesIf not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. If NULL all properties must be returned. the returned Object MUST match the value of this parameter).
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_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_NOT_FOUND Instance not found.

◆ cleanup

CMPIStatus(* _CMPIAssociationMIFT::cleanup) (CMPIAssociationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)

Cleanup is called prior to unloading of the provider. This function shall perform any necessary cleanup operations prior to the unloading of the library of which this MI group is part.

Parameters
miThis argument is a pointer to a CMPIAssociationMI structure.
ctxThis argument is a pointer to a CMPIContext structure containing the Invocation 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 _CMPIAssociationMIFT::ftVersion

Function table version

◆ miName

const char* _CMPIAssociationMIFT::miName

Provider name

◆ miVersion

const CMPISint32 _CMPIAssociationMIFT::miVersion

Provider version

◆ referenceNames

CMPIStatus(* _CMPIAssociationMIFT::referenceNames) (CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *resultClass, const char *role)

Enumerates the association ObjectPaths that refer to the instance defined by <op>.

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opSource ObjectPath containing namespace, classname and key components.
resultClassIf not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
roleIf not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
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_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_NOT_FOUND Instance not found.

◆ references

CMPIStatus(* _CMPIAssociationMIFT::references) (CMPIAssociationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPIObjectPath *op, const char *resultClass, const char *role, const char **properties)

Enumerates the association instances that refer to the instance defined by <op>.

Parameters
miProvider this pointer.
ctxInvocation Context
rsltResult data container.
opSource ObjectPath containing namespace, classname and key components.
resultClassIf not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
roleIf not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
propertiesIf not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list
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_NOT_SUPPORTED Operation not supported by this MI. CMPI_RC_ERR_ACCESS_DENIED Not authorized. CMPI_RC_ERR_NOT_FOUND Instance not found.

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