_CMPIAssociationMIFT Struct Reference

This structure is a table of pointers providing access to Association provider functions. More...

#include <cmpift.h>

Collaboration diagram for _CMPIAssociationMIFT:

[legend]List of all members.

Public Attributes
int	ftVersion
	Function table version.
int	miVersion
	Provider version.
char *	miName
	Provider name.
CMPIStatus(*	cleanup )(CMPIAssociationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)
	Cleanup is called prior to unloading of the provider.
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)
	Enumerate ObjectPaths associated with the Instance defined by <op>.
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)
	Enumerate ObjectPaths associated with the Instance defined by <op>.
CMPIStatus(*	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>.
CMPIStatus(*	referenceNames )(CMPIAssociationMI *, const CMPIContext *, const CMPIResult *, const CMPIObjectPath *, const char *, const char *)
	Enumerates the association ObjectPaths that refer to the instance defined by <op>.

---

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.

Definition at line 2261 of file cmpift.h.

---

Member Data Documentation

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: mi  Provider this pointer. ctx  Invocation Context rslt  Result data container. op  Source ObjectPath containing namespace, classname and key components. assocClass  If 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. resultClass  If 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). role  If 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). resultRole  If 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.

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: mi  Provider this pointer. ctx  Invocation Context rslt  Result data container. op  Source ObjectPath containing namespace, classname and key components. assocClass  If 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. resultClass  If 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). role  If 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). resultRole  If 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 properties  If 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.

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

Cleanup is called prior to unloading of the provider. Parameters: mi  Provider this pointer. ctx  Invocation Contconst terminating  When 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. Referenced by OW_NAMESPACE::CMPIProviderIFC::doUnloadProviders(), and OW_NAMESPACE::CMPIProviderIFC::~CMPIProviderIFC().

int _CMPIAssociationMIFT::ftVersion

Function table version. Definition at line 2265 of file cmpift.h.

char* _CMPIAssociationMIFT::miName

Provider name. Definition at line 2273 of file cmpift.h.

int _CMPIAssociationMIFT::miVersion

Provider version. Definition at line 2269 of file cmpift.h.

CMPIStatus(* _CMPIAssociationMIFT::referenceNames)(CMPIAssociationMI *, const CMPIContext *, const CMPIResult *, const CMPIObjectPath *, const char *, const char *)

Enumerates the association ObjectPaths that refer to the instance defined by <op>. Parameters: mi  Provider this pointer. ctx  Invocation Context rslt  Result data container. op  Source ObjectPath containing namespace, classname and key components. resultClass  If 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). role  If 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.

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: mi  Provider this pointer. ctx  Invocation Context rslt  Result data container. op  Source ObjectPath containing namespace, classname and key components. resultClass  If 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). role  If 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). properties  If 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 documentation for this struct was generated from the following file:

• cmpift.h

---