CMPI 2.1.0 API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
CMPIIndicationMIFT Struct Reference

Function table of CMPIIndicationMI 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 )(CMPIIndicationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)
 Perform cleanup for an Indication MI. More...
 
CMPIStatus(* authorizeFilter )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, const char *owner)
 Verify whether an indication filter is supported by the MI. More...
 
CMPIStatus(* mustPoll )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath)
 Ask the MI whether indication polling should be used for an indication filter. (Deprecated) More...
 
CMPIStatus(* activateFilter )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean firstActivation)
 Informs the MI that an indication filter has become active. More...
 
CMPIStatus(* deActivateFilter )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean lastDeActiviation)
 Informs the MI that an indication filter has become inactive. More...
 
CMPIStatus(* enableIndications )(CMPIIndicationMI *mi, const CMPIContext *ctx)
 Informs the MI that the MB is now ready to process the delivery of indications. More...
 
CMPIStatus(* disableIndications )(CMPIIndicationMI *mi, const CMPIContext *ctx)
 Informs the MI that the MB is no longer ready to process the delivery of indications. More...
 
CMPIStatus(* authorizeFilterCollection )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIInstance *collInst)
 Verify whether an indication filter collection is supported by the MI. More...
 
CMPIStatus(* activateFilterCollection )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIInstance *collInst, CMPIBoolean firstActivation)
 Informs the MI that an indication filter collection has become active. More...
 
CMPIStatus(* deActivateFilterCollection )(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIInstance *collInst, CMPIBoolean lastDeActivation)
 Informs the MI that an indication filter collection has become inactive. More...
 

Detailed Description

Function table of CMPIIndicationMI object.

Field Documentation

CMPIVersion CMPIIndicationMIFT::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(* CMPIIndicationMIFT::cleanup)(CMPIIndicationMI *mi, const CMPIContext *ctx, CMPIBoolean terminating)

Perform cleanup for an Indication MI.

CMPIIndicationMIFT.cleanup() shall perform any necessary cleanup for the Indication 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
miPoints to a CMPIIndicationMI structure.
ctxPoints 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
CMIndicationMIStub()
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(* CMPIIndicationMIFT::authorizeFilter)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, const char *owner)

Verify whether an indication filter is supported by the MI.

CMPIIndicationMIFT.authorizeFilter() shall verify whether an indication filter is supported by the MI.

An MB implementation is free to choose whether this function is called when the MB starts up independently of whether or not there are any subscriptions for the filter, or only when the first subscription to the filter is made.

In any case, for any particular filter this function is called on, it shall be called by the MB before CMPIIndicationMIFT.activateFilter() is called for the first time on the same filter.

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. There is no defined client operation that determines the context data. As a result, not all context data entries may be present.
filterPoints to a CMPISelectExp object containing the filter specification defined by the indication filter that is being verified.
classNameClass name extracted from the FROM-clause of the filter specification contained in the filter argument. If the filter specification contains joins, it is undefined which of the joined classes is used for this argument.
classPathPoints to a CMPIObjectPath object that is a reference to a class or to a namespace, as follows:
  • If the filter specification covers lifecycle indications, the CMPIObjectPath object specifies the class path of the class for which lifecycle monitoring is required. Note that this class may be a subclass of the class specified in className, for example when the filter query constrains the class to be monitored using constructs such as the ISA operator of CQL.
  • If the filter specification covers process indications, the CMPIObjectPath object specifies the namespace path of the origin namespace of the process indications.
ownerDestination owner. (Deprecated)
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, filter is supported.
  • CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by this MI, or filter is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized. Note: This return code indicates general authorization related issues and does not specifically indicate that the filter itself would not be authorized.
  • CMPI_RC_ERR_INVALID_QUERY - Filter query is invalid or too complex.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
Deprecated:
The owner argument is deprecated since CMPI 2.1. MBs may pass an empty string in owner. For compatibility reasons, MBs shall not pass a NULL pointer in owner.
CMPIStatus(* CMPIIndicationMIFT::mustPoll)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIResult *rslt, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath)

Ask the MI whether indication polling should be used for an indication filter. (Deprecated)

CMPIIndicationMIFT.mustPoll() asks the MI whether indication polling should be used for an indication filter.

This function enables very simple MIs to support indications without providing a complete indication support implementation. When true is returned, the MI indicates to the MB that it relies on indication polling for this indication filter. If the MB supports indication polling and the MI relies on indication polling, the MB will invoke appropriate instance MI functions at regular intervals, apply the specified indication filter and deliver any resulting indications.

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. There is no defined client operation that determines the context data. As a result, not all context data entries may be present.
[out]rsltPoints to a CMPIResult object used to return a CMPIBoolean indicating whether indication polling should be used.
filterPoints to a CMPISelectExp object containing the filter specification defined by the indication filter for which this request is made.
classNameClass name extracted from the FROM-clause of the filter specification contained in the filter argument. If the filter specification contains joins, it is undefined which of the joined classes is used for this argument.
classPathPoints to a CMPIObjectPath object that is a reference to a class or to a namespace, as follows:
  • If the filter specification covers lifecycle indications, the CMPIObjectPath object specifies the class path of the class for which lifecycle monitoring is required. Note that this class may be a subclass of the class specified in className, for example when the filter query constrains the class to be monitored using constructs such as the ISA operator of CQL.
  • If the filter specification covers process indications, the CMPIObjectPath object specifies the namespace path of the origin namespace of the process indications.
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_NOT_SUPPORTED - Function is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized.
  • CMPI_RC_ERR_INVALID_QUERY - Invalid query or too complex.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
Incompatibility:
In CMPI 2.1, the rslt argument was added to the declaration of this function in the header file, in order to get the header files consistent with the CMPI Standard, which always had this argument documented. It is believed that this function could not have been used without that argument, and that users of the function would have added the argument already.
Deprecated:
This function is deprecated since CMPI 2.1, because the concept of indication polling has been deprecated in CMPI 2.1.
CMPIStatus(* CMPIIndicationMIFT::activateFilter)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean firstActivation)

Informs the MI that an indication filter has become active.

CMPIIndicationMIFT.activateFilter() informs the MI that the specified indication filter has become active. This function shall be called by the MB:

  • when a client creates a subscription to an indication filter, and
  • if persisted subscriptions are supported by the MB, for any persisted subscriptions to indication filters when the MB starts up.

An MB implementation is free to choose whether this function is called upon each subscription to a particular filter, or only upon the first subscription (see firstActivation). As a result, the MI will always be informed about the first activation of the filter after having been inactive, but has no guarantee to be informed about subsequent activations of the same filter.

Generally, MIs should disable the monitoring of any resources for indications if there is no interest in them. Consequently, in this function the MI needs to start the monitoring of any resources that trigger indications that are covered by the specified indication filter, during the first activation of the filter. For the concept of coverage of indications by an indication filter, see DSP1054.

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. If the filter is activated because a client creates a subscription to the filter, the client operation that creates the subscription determines the context data. If the filter is activated during MB startup on behalf of a persisted earlier subscription, the client operation that originally created the subscription determines the context data.
filterPoints to a CMPISelectExp object containing the filter specification defined by the indication filter that is activated.
classNameclass name extracted from the FROM-clause of the filter specification contained in filter. If the filter specification contains joins, it is undefined which of the joined classes is used for this argument.
classPathPoints to a CMPIObjectPath object that is a reference to a class or to a namespace, as follows:
  • If the filter specification covers lifecycle indications, the CMPIObjectPath object specifies the class path of the class for which lifecycle monitoring is required. Note that this class may be a subclass of the class specified in className, for example when the filter query constrains the class to be monitored using constructs such as the ISA operator of CQL.
  • If the filter specification covers process indications, the CMPIObjectPath object specifies the namespace path of the origin namespace of the process indications.
firstActivationSet to true if this is the first activation of this indication filter after having been inactive, and is set to false otherwise.
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_NOT_SUPPORTED - Function is not supported by this MI, or filter is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized. Note: This return code indicates general authorization related issues and does not specifically indicate that the filter itself would not be authorized.
  • CMPI_RC_ERR_INVALID_QUERY - Filter query is invalid or too complex.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
CMPIStatus(* CMPIIndicationMIFT::deActivateFilter)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPISelectExp *filter, const char *className, const CMPIObjectPath *classPath, CMPIBoolean lastDeActiviation)

Informs the MI that an indication filter has become inactive.

CMPIIndicationMIFT.deActivateFilter() informs the MI that the specified indication filter has become inactive. This function shall be called by the MB:

  • when a client deletes a subscription to an indication filter, and
  • for any existing subscriptions to indication filters, when the MB shuts down.

An MB implementation is free to choose whether this function is called for each deletion of a subscription to a particular filter, or only upon the last deletion (see lastDeActivation). As a result, the MI will always be informed about the last deactivation of the filter, but has no guarantee to be informed about prior deactivations of the same filter.

Generally, MIs should disable the monitoring of any resources for indications if there is no interest in them. Consequently, in this function the MI should stop the monitoring of any resources that trigger indications that are covered by the specified indication filter, during the last deactivation of the filter. For the concept of coverage of indications by an indication filter, see DSP1054.

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. If the filter is deactivated because a client deletes a subscription to the filter, the client operation that deletes the subscription determines the context data. If the filter is deactivated during MB shutdown, the client operation that originally created the subscription determines the context data.
filterPoints to a CMPISelectExp object containing the filter specification defined by the indication filter that is deactivated.
classNameClass name extracted from the FROM-clause of the filter specification contained in the filter argument. If the filter specification contains joins, it is undefined which of the joined classes is used for this argument.
classPathPoints to a CMPIObjectPath object is a reference to a class or to a namespace, as follows:
  • If the filter specification covers lifecycle indications, the CMPIObjectPath object specifies the class path of the class for which lifecycle monitoring is required. Note that this class may be a subclass of the class specified in className, for example when the filter query constrains the class to be monitored using constructs such as the ISA operator of CQL.
  • If the filter specification covers process indications, the CMPIObjectPath object specifies the namespace path of the origin namespace of the process indications.
lastDeActiviationSet to true if this is the last deactivation of this indication filter after having been active, and is set to false otherwise.
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_NOT_SUPPORTED - Function is not supported by this MI, or filter is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized.
  • CMPI_RC_ERR_INVALID_QUERY - Filter query is invalid or too complex.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
CMPIStatus(* CMPIIndicationMIFT::enableIndications)(CMPIIndicationMI *mi, const CMPIContext *ctx)

Informs the MI that the MB is now ready to process the delivery of indications.

CMPIIndicationMIFT.enableIndications() informs the MI that the MB is now ready to process the delivery of indications. This function is typically called when the MB is starting up its indication services (from either a permanent or temporary shutdown of its indication services).

The relative order in which an MB enables indications using this function and activates filters and filter collections is not defined. As a result, MIs need to track the readiness of the MB to process the delivery of indications and check that readiness before calling CMPIBrokerFT::deliverIndication().

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. There is no defined client operation that determines the context data. As a result, not all context data entries may be present.
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_NOT_SUPPORTED - Function is not supported by this MI.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
CMPIStatus(* CMPIIndicationMIFT::disableIndications)(CMPIIndicationMI *mi, const CMPIContext *ctx)

Informs the MI that the MB is no longer ready to process the delivery of indications.

CMPIIndicationMIFT.disableIndications() informs the MI that the MB is no longer ready to process the delivery of indications. This function is typically called when the MB is shutting down its indication services either temporarily or permanently.

The relative order in which an MB disables indications using this function and deactivates filters and filter collections is not defined. As a result, MIs need to track the readiness of the MB to process the delivery of indications and check that readiness before calling CMPIBrokerFT::deliverIndication().

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. There is no defined client operation that determines the context data. As a result, not all context data entries may be present.
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_NOT_SUPPORTED - Function is not supported by this MI.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
CMPIStatus(* CMPIIndicationMIFT::authorizeFilterCollection)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIInstance *collInst)

Verify whether an indication filter collection is supported by the MI.

CMPIIndicationMIFT.authorizeFilterCollection() shall verify whether an indication filter collection is supported by the MI.

An MB implementation is free to choose whether this function is called when the MB starts up independently of whether or not there are any subscriptions for the filter collection, or only when the first subscription to the filter collection is made.

In any case, for any particular filter collection this function is called on, it shall be called by the MB before CMPIIndicationMIFT.activateFilterCollection() is called for the first time on the same filter collection.

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. There is no defined client operation that determines the context data. As a result, not all context data entries may be present.
collInstPoints to a CMPIInstance object with the CIM_FilterCollection instance representing the indication filter collection. Note that the indication filter collection can be identified by inspecting the CollectionName property of this instance.
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, filter collection is supported by the MI.
  • CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by this MI, or filter collection is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized. Note: This return code indicates general authorization related issues and does not specifically indicate that the filter collection itself would not be authorized.
  • CMPI_RC_ERR_INVALID_PARAMETER - Invalid indication filter collection.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
Addition:
Added in CMPI 2.1.
CMPIStatus(* CMPIIndicationMIFT::activateFilterCollection)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIInstance *collInst, CMPIBoolean firstActivation)

Informs the MI that an indication filter collection has become active.

CMPIIndicationMIFT.activateFilterCollection() informs the MI that the specified indication filter collection has become active. This function shall be called by the MB:

  • when a client creates a subscription to an indication filter collection, and
  • if persisted subscriptions are supported by the MB, for any persisted subscriptions to indication filter collections when the MB starts up.

An MB implementation is free to choose whether this function is called upon each subscription to a particular filter collection, or only upon the first subscription (see firstActivation).

As a result, the MI will always be informed about the first activation of the filter collection, but has no guarantee to be informed about subsequent activations of the same filter collection.

Generally, MIs should disable the monitoring of any resources for indications if there is no interest in them. Consequently, in this function the MI needs to start the monitoring of any resources that trigger indications that are covered by the specified indication filter collection, during the first activation of the filter collection. For the concept of coverage of indications by an indication filter collection, see DSP1054.

As described in DSP1054, a filter collection conceptually has members, but these members do not need to be instantiated using CIM. An MB shall handle subscriptions to a filter collection by calling CMPIIndicationMIFT.activateFilterCollection() for that filter collection; the MB shall not additionally call the activation functions for the individual members of the filter collection. The implementation of CMPIIndicationMIFT.activateFilterCollection() is responsible for activating the entire filter collection including all of its members (regardless of whether or not these members are instantiated using CIM).

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. If the filter collection is activated because a client creates a subscription to the filter collection, the client operation that creates the subscription determines the context data. If the filter collection is activated during MB startup on behalf of a persisted earlier subscription, the client operation that originally created the subscription determines the context data.
collInstPoints to a CMPIInstance object with the CIM_FilterCollection instance representing the indication filter collection. Note that the indication filter collection can be identified by inspecting the CollectionName property of this instance.
firstActivationSet to true if this is the first activation of this indication filter collection after having been inactive, and is set to false otherwise
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_NOT_SUPPORTED - Function is not supported by this MI, or filter collection is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized. Note: This return code indicates general authorization related issues and does not specifically indicate that the filter collection itself would not be authorized.
  • CMPI_RC_ERR_INVALID_PARAMETER - Invalid indication filter collection.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
Addition:
Added in CMPI 2.1.
CMPIStatus(* CMPIIndicationMIFT::deActivateFilterCollection)(CMPIIndicationMI *mi, const CMPIContext *ctx, const CMPIInstance *collInst, CMPIBoolean lastDeActivation)

Informs the MI that an indication filter collection has become inactive.

CMPIIndicationMIFT.deActivateFilterCollection() informs the MI that the specified indication filter collection has become inactive. This function shall be called by the MB:

  • when a client deletes a subscription to an indication filter collection, and
  • for any existing subscriptions to indication filter collections when the MB shuts down.

This function is called either when a client deletes a subscription to an indication filter collection, or when the MB shuts down and deactivates a subscription.

An MB implementation is free to choose whether this function is called upon each deletion of a subscription to a particular filter collection, or only upon the last deletion (see lastDeActivation). As a result, the MI will always be informed about the last deactivation of the filter collection, but has no guarantee to be informed about prior deactivations of the same filter collection.

Generally, MIs should disable the monitoring of any resources for indications if there is no interest in them. Consequently, in this function the MI should stop the monitoring of any resources that trigger indications that are covered by the specified indication filter collection, during the last deactivation of the filter. For the concept of coverage of indications by an indication filter collection, see DSP1054.

As described in DSP1054, a filter collection conceptually has members, but these members do not need to be instantiated using CIM. An MB shall handle deletions to subscriptions to a filter collection by calling CMPIIndicationMIFT.deActivateFilterCollection() for that filter collection; the MB shall not additionally call the deactivation functions for the individual members of the filter collection. The implementation of CMPIIndicationMIFT.deActivateFilterCollection() is responsible for deactivating the entire filter collection including all of its members (regardless of whether or not these members are instantiated using CIM).

Parameters
miPoints to a CMPIIndicationMI structure.
ctxPoints to a CMPIContext object containing the context data for the invocation. If the filter collection is activated because a client creates a subscription to the filter collection, the client operation that creates the subscription determines the context data. If the filter collection is activated during MB startup on behalf of a persisted earlier subscription, the client operation that originally created the subscription determines the context data.
collInstPoints to a CMPIInstance object with the CIM_FilterCollection instance representing the indication filter collection. Note that the indication filter collection can be identified by inspecting the CollectionName property of this instance.
lastDeActivationSet to true if this is the last deactivation of this indication filter collection after having been active; set to false otherwise.
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_NOT_SUPPORTED - Function is not supported by this MI, or filter collection is not supported by this MI.
  • CMPI_RC_ERR_ACCESS_DENIED - Not authorized. Note: This return code indicates general authorization related issues and does not specifically indicate that the filter collection itself would not be authorized.
  • CMPI_RC_ERR_INVALID_PARAMETER - Invalid indication filter collection.
  • CMPI_RC_ERR_FAILED - Other error occurred.
Convenience Function
CMIndicationMIStub()
Addition:
Added in CMPI 2.1.

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