cmpimacs.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

/** Sets the 'other' error type of this error object.
    @param er Error this pointer
    @param oet A string which describes the error type, it is only valis when error type is "OTHER"
    @return Output: Service return status
 */
inline static CMPIStatus (*setOtherErrorType)(CMPIError* er, const char * oet)
{
  return ((er)->ft->setOtherErrorType ((er), (oet)));
}
#   else
#      define CMSetOtherErrorType(e,oet)                               \
              ((e)->ft->setOtherErrorType((e),(oet)))
#   endif

#   ifdef CMPI_INLINE
/** Sets the description of the probable cause.
    @param er Error this pointer
    @param pc The probable cause string
    @return Output: Service return status
 */
inline static CMPIStatus (*setProbableCauseDescription)(
    CMPIError* er, const char * pcd)
{
  return ((er)->ft->setProbableCauseDescription ((er), (pcd)));
}
#   else
#      define CMSetProbableCauseDescription(e,pcd)                     \
              ((e)->ft->setProbableCauseDescription((e),(pcd)))
#   endif

#   ifdef CMPI_INLINE
/** Sets the recomended actions array.
    @param er Error this pointer
    @param ar An array of strings describing actions that shoudl be taken to deal with this error
    @return Output: Service return status
 */
inline static CMPIStatus (*setRecommendedActions)(
    CMPIError* er, const CMPIArray* ra)
{
  return ((er)->ft->setRecommendedActions ((er), (ra)));
}
#   else
#      define CMSetRecommendedActions(e,ra)                            \
              ((e)->ft->setRecommendedActions((e),(ra)))
#   endif

#   ifdef CMPI_INLINE
/** Specifies a string which specifes The identifying information of the entity (i.e., the instance) generating the error..
    @param er Error this pointer
    @param es the string which describes the source
    @return Output: Service return status
 */
inline static CMPIStatus (*setErrorSource)(CMPIError* er, const char* es);
{
  return ((er)->ft->setErrorSource ((er), (es)));
}
#   else
#      define CMSetErrorSource(e,es)                                   \
              ((e)->ft->setErrorSource((e),(es)))
#   endif

#   ifdef CMPI_INLINE
/** Sets the source format of the error object
    @param er Error this pointer
    @param esf the string which describes the source format
    @return Output: Service return status
 */
inline static CMPIStatus (*setErrorSourceFormat)(
    CMPIError* er, const CMPIErrorSrcFormat esf);
{
  return ((er)->ft->setErrorSourceFormat ((er), (esf)));
}
#   else
#      define CMSetErrorSourceFormat(e,esf)                            \
              ((e)->ft->setErrorSourceFormat((e),(esf)))
#   endif

#   ifdef CMPI_INLINE
/** specifies A string defining "Other" values for ErrorSourceFormat
    @param er Error this pointer
    @param oef the string which describes the other source format
    @return Output: Service return status
 */
inline static CMPIStatus (*setOtherErrorSourceFormat)(
    CMPIError* er, const char* oesf)
{
  return ((er)->ft->setOtherErrorSourceFormat ((er), (oesf)));
}
#   else
#      define CMSetOtherErrorSourceFormat(e,oesf)                      \
              ((e)->ft->setOtherErrorSourceFormat((e),(oesf)))
#   endif

#   ifdef CMPI_INLINE
/** Sets the description of the status code.
    @param er Error this pointer
    @param scd A string whcih describes the status code.
    @return Output: Service return status
 */
inline static CMPIStatus (*setCIMStatusCodeDescription)(
    CMPIError* er, const char* cd);
{
  return ((er)->ft->setCIMStatusCodeDescription ((er), (cd)));
}
#   else
#      define CMSetCIMStatusCodeDescription(e,cd)                      \
              ((e)->ft->setCIMStatusCodeDescription((e),(cd)))
#   endif
#   ifdef CMPI_INLINE
/** Sets an array of strings for the dynamic content of the message
    @param er Error this pointer
    @param values Specifies an array of CMPIStrings containing the dynamic
    content of the message.
    @return Service return status
 */
inline static CMPIStatus (*setMessageArguments)(CMPIError* er, CMPIArray* ma)
{
  return ((er)->ft->setMessageArguments ((er), (ma)));
}
#   else
#      define CMSetMessageArguments(e,ma)                              \
              ((e)->ft->setMessageArguments((e),(ma)))
#   endif

#   endif /* CMPI_VER_200 */


    // CMPIEnumeration Macros


#   ifdef CMPI_INLINE
       /** Get the next element of this Enumeration.
	 @param en Enumeration this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return Element value.
      */
inline static CMPIData
CMGetNext (const CMPIEnumeration * en, CMPIStatus * rc)
{
  return ((en)->ft->getNext ((en), (rc)));
}
#   else
#      define CMGetNext(n,rc)                    ((n)->ft->getNext((n),(rc)))
#   endif

#   ifdef CMPI_INLINE
       /** Test for any elements left in this Enumeration.
	 @param en Enumeration this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return True or false.
      */
inline static CMPIBoolean CMHasNext
  (const CMPIEnumeration * en, CMPIStatus * rc)
{
  return ((en)->ft->hasNext ((en), (rc)));
}
#   else
#      define CMHasNext(n,rc)                    ((n)->ft->hasNext((n),(rc)))
#   endif

#   ifdef CMPI_INLINE
       /** Convert this Enumeration into an Array.
	 @param en Enumeration this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return The Array.
      */
inline static CMPIArray *CMToArray
  (const CMPIEnumeration * en, CMPIStatus * rc)
{
  return ((en)->ft->toArray ((en), (rc)));
}
#   else
#      define CMToArray(n,rc)                   ((n)->ft->toArray((n),(rc)))
#   endif


   // CMPIResult Macros


#   ifdef CMPI_INLINE
       /** Return a value/type pair.
	 @param rslt Result this pointer.
	 @param value Address of a Value object.
	 @param type Type of the Value object.
	 @return Service return status.
      */
inline static CMPIStatus CMReturnData
  (const CMPIResult * rslt, const CMPIValue * value, const CMPIType type)
{
  return ((rslt)->ft->returnData ((rslt), (value), (type)));
}
#   else
#      define CMReturnData(r,v,t) \
                           ((r)->ft->returnData((r),(CMPIValue*)(v),(t)))
#   endif

#   ifdef CMPI_INLINE
       /** Return a Instance object.
	 @param rslt Result this pointer.
	 @param inst Instance to be returned.
	 @return Service return status.
      */
inline static CMPIStatus CMReturnInstance
  (const CMPIResult * rslt, const CMPIInstance * inst)
{
  return ((rslt)->ft->returnInstance ((rslt), (inst)));
}
#   else
#      define CMReturnInstance(r,i)        ((r)->ft->returnInstance((r),(i)))
#   endif

#   ifdef CMPI_INLINE
       /** Return a ObjectPath object..
	 @param rslt Result this pointer.
	 @param ref ObjectPath to be returned.
	 @return Service return status.
      */
inline static CMPIStatus CMReturnObjectPath
  (const CMPIResult * rslt, const CMPIObjectPath * ref)
{
  return ((rslt)->ft->returnObjectPath ((rslt), (ref)));
}
#   else
#      define CMReturnObjectPath(r,o)    ((r)->ft->returnObjectPath((r),(o)))
#   endif

#   ifdef CMPI_INLINE
       /** Indicates no further data to be returned.
	 @param rslt Result this pointer.
	 @return Service return status.
      */
inline static CMPIStatus
CMReturnDone (const CMPIResult * rslt)
{
  return ((rslt)->ft->returnDone ((rslt)));
}
#   else
#      define CMReturnDone(r)                      ((r)->ft->returnDone((r)))
#   endif

#   ifdef CMPI_VER_200
#   ifdef CMPI_INLINE
	  /** Return a CMPIError object instance
	 @param rslt Result this pointer.
	 @param er Error to be returned.
	 @return Service return status.
	  */
inline static CMPIStatus CMReturnError
  (const CMPIResult* rslt, const CMPIError* er)
{
  return ((rslt)->ft->returnError ((rslt), (er)));
}
#   else
#      define CMReturnError(r,e) \
                           ((r)->ft->returnError((r),(e)))
#   endif
#   endif /* CMPI_VER_200 */


    // CMPIContext Macros


#   ifdef CMPI_INLINE
       /** Gets a named Context entry value.
	 @param ctx Context this pointer.
	 @param name Context entry name.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return Entry value.
      */
inline static CMPIData CMGetContextEntry
  (const CMPIContext * ctx, const char *name, CMPIStatus * rc)
{
  return ((ctx)->ft->getEntry ((ctx), (name), (rc)));
}
#   else
#      define CMGetContextEntry(c,n,rc)  \
                                 ((c)->ft->getEntry((c),(n),(rc)))
#   endif

#   ifdef CMPI_INLINE
       /** Gets a Context entry value defined by its index.
	 @param ctx Context this pointer.
	 @param index Position in the internal Data array.
	 @param name Output: Returned Context entry name (suppressed when NULL).
	 @param rc Output: Service return status (suppressed when NULL).
	 @return Entry value.
      */
inline static CMPIData CMGetContextEntryAt
  (const CMPIContext * ctx, CMPICount index, CMPIString ** name,
   CMPIStatus * rc)
{
  return ((ctx)->ft->getEntryAt ((ctx), (index), (name), (rc)));
}
#   else
#      define CMGetContextEntryAt(c,p,n,rc) \
                         ((c)->ft->getEntryAt((c),(p),(n),(rc)))
#   endif

#   ifdef CMPI_INLINE
      /** Gets the number of entries contained in this Context.
	 @param ctx Context this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return Number of entries.
      */
inline static CMPICount CMGetContextEntryCount
  (const CMPIContext * ctx, CMPIStatus * rc)
{
  return ((ctx)->ft->getEntryCount ((ctx), (rc)));
}
#   else
#      define CMGetContextEntryCount(c,rc) \
                                ((c)->ft->getEntryCount((c),(rc)))
#   endif

#   ifdef CMPI_INLINE
      /** adds/replaces a named Context entry
	 @param ctx Context this pointer.
         @param name Entry name.
         @param value Address of value structure.
         @param type Value type.
	 @return Service return status.
      */
inline static CMPIStatus CMAddContextEntry
  (const CMPIContext * ctx, const char *name, const CMPIValue * value,
   const CMPIType type)
{
  return ((ctx)->ft->addEntry ((ctx), (name), (value), (type)));
}
#   else
#      define CMAddContextEntry(c,n,v,t) \
                  ((c)->ft->addEntry((c),(n),(CMPIValue*)(v),(t)))
#   endif



    // CMPISelectExp macros



#   ifdef CMPI_INLINE
       /** Return the select expression in string format.
	 @param se SelectExp this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return The select expression.
      */
inline static CMPIString *CMGetSelExpString
  (const CMPISelectExp * se, CMPIStatus * rc)
{
  return ((se)->ft->getString ((se), (rc)));
}
#   else
#      define CMGetSelExpString(s,rc)          ((s)->ft->getString((s),(rc)))
#   endif

#   ifdef CMPI_INLINE
       /** Evaluate the instance using this select expression.
	 @param se SelectExp this pointer.
	 @param inst Instance to be evaluated.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return True or false incicator.
      */
inline static CMPIBoolean CMEvaluateSelExp
  (const CMPISelectExp * se, const CMPIInstance * inst, CMPIStatus * rc)
{
  return ((se)->ft->evaluate ((se), (inst), (rc)));
}
#   else
#      define CMEvaluateSelExp(s,i,r)        ((s)->ft->evaluate((s),(i),(r)))
#   endif

#   ifdef CMPI_VER_87
#   ifdef CMPI_INLINE
       /** Evaluate this select expression by using a data value accessor routine. .
	 @param se SelectExp this pointer.
	 @param accessor Data accessor routine to be used.
	 @param parm Data accessor parameter.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return True or false incicator.
      */
inline static CMPIBoolean CMEvaluateSelExpUsingAccessor
  (const CMPISelectExp * se, CMPIAccessor * accessor, void *parm,
   CMPIStatus * rc)
{
  return ((se)->ft->evaluateUsingAccessor ((se), (accessor), (parm), (rc)));
}
#   else
#      define CMEvaluateSelExpUsingAccessor(s,i,p,r) \
                            ((s)->ft->evaluateUsingAccessor((s),(i),(p),(r)))
#   endif
#   endif /* CMPI_VER_87 */

#   ifdef CMPI_INLINE
       /** Return the select expression as disjunction of conjunctions.
	 @pa