cmpift.h

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

      */
      CMPIData (*getEntryAt)
      (const CMPIContext * ctx, CMPICount index, CMPIString ** name,
       CMPIStatus * rc);

      /** Gets the number of entries contained in this Context.
	 @param ctx Context this pointer.
	 @return Number of entries.
      */
      CMPICount (*getEntryCount) (const CMPIContext * ctx, CMPIStatus * rc);

      /** 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.
      */
      CMPIStatus (*addEntry)
      (const CMPIContext * ctx, const char *name, const CMPIValue * value,
       const CMPIType type);
  };




  //---------------------------------------------------
  //--
  //   _CMPIContext Encapsulated object
  //--
  //---------------------------------------------------


   /** This structure represents the Encapsulated Context object.
   */
  struct _CMPIContext
  {

       /** Opaque pointer to MB specific implementation data.
       */
    void *hdl;

       /** Pointer to the Context Function Table.
       */
    CMPIContextFT *ft;
  };




  //---------------------------------------------------
  //--
  //   _CMPIResult Encapsulated object
  //--
  //---------------------------------------------------


   /** This structure represents the Encapsulated Result object.
   */
  struct _CMPIResult
  {

       /** Opaque pointer to MB specific implementation data.
       */
    void *hdl;

       /** Pointer to the Result Function Table.
       */
    CMPIResultFT *ft;
  };


  //---------------------------------------------------
  //--
  //   _CMPIResult Function Table
  //--
  //---------------------------------------------------


   /** This structure is a table of pointers providing access to Result
       support sevices. Result support services are used to explicity return
       data produced by provider functions.
   */
  struct _CMPIResultFT
  {

       /** Function table version
       */
    int ftVersion;

       /** The Result object will not be used any further and may be freed by
           CMPI run time system.
	 @param rslt Result this pointer.
	 @return Service return status.
      */
      CMPIStatus (*release) (CMPIResult * rslt);

       /** Create an independent copy of this Result object.
	 @param rslt Result this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return Pointer to copied Result object.
      */
    CMPIResult *(*clone) (const CMPIResult * rslt, CMPIStatus * rc);

       /** 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.
      */
      CMPIStatus (*returnData)
      (const CMPIResult * rslt, const CMPIValue * value, const CMPIType type);

       /** Return a Instance object.
	 @param rslt Result this pointer.
	 @param inst Instance to be returned.
	 @return Service return status.
      */
      CMPIStatus (*returnInstance)
      (const CMPIResult * rslt, const CMPIInstance * inst);

       /** Return a ObjectPath object.
	 @param rslt Result this pointer.
	 @param ref ObjectPath to be returned.
	 @return Service return status.
      */
      CMPIStatus (*returnObjectPath)
      (const CMPIResult * rslt, const CMPIObjectPath * ref);

       /** Indicates no further data to be returned.
	 @param rslt Result this pointer.
	 @return Service return status.
      */
      CMPIStatus (*returnDone) (const CMPIResult * rslt);

#   ifdef CMPI_VER_200
	  /** Return a CMPIError object instance
	 @param rslt Result this pointer.
	 @param er Error to be returned.
	 @return Service return status.
	  */
	CMPIStatus (*returnError)(const CMPIResult* rslt,
		const CMPIError* er);
#   endif
  };

#   ifdef CMPI_VER_200
  struct _CMPIError
  {
    void *hdl;
    CMPIErrorFT *ft;
  };

  //---------------------------------------------------
  //--
  //   _CMPIErrorFT Function Table
  //--
  //---------------------------------------------------


   /** This structure is a table of pointers providing access to Error
       support services.
   */
  struct _CMPIErrorFT
  {
       /** Function table version
       */
    CMPISint32 ftVersion;
       /** The Error object will not be used any further and may be freed by
           CMPI run time system.
	 @param er Error this pointer.
	 @return Service return status.
      */
    CMPIStatus (*release)(CMPIError*);
       /** Create an independent copy of this Error object.
	 @param er Error this pointer.
	 @param rc Output: Service return status (suppressed when NULL).
	 @return Pointer to copied Error object.
      */
    CMPIError* (*clone)(const CMPIError*, CMPIStatus*);
	/** Gets the type of this Error
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return the error type this Error object conatins
	*/
    CMPIErrorType (*getErrorType)(const CMPIError*, CMPIStatus*);
	/** Returns a string which describes the alternate error type.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getOtherErrorType)(const CMPIError*, CMPIStatus*);
	/** Returns a string which describes the owneing entity
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getOwningEntity)(const CMPIError*, CMPIStatus*);
	/** Returns a string which is the message ID.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getMessageID)(const CMPIError*, CMPIStatus*);
	/** Returns a string comnating an error message.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getMessage)(const CMPIError*, CMPIStatus*);
	/** Returns the perceieved severity of this error.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return the perceived severity
	*/
    CMPIErrorSeverity (*getPerceivedSeverity)(const CMPIError*, CMPIStatus*);
	/** Returns the probable cause of this error.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A probable cause value
	*/
    CMPIErrorProbableCause (*getProbableCause)(const CMPIError*, CMPIStatus*);
	/** Returns a string which describes the probable cause.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getProbableCauseDescription)(const CMPIError*, CMPIStatus*);
	/** Returns an array of strings which describes recomended actions.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A array of strings, which can be NULL
	*/
    CMPIArray* (*getRecommendedActions)(const CMPIError*, CMPIStatus*);
	/** Returns a string which describes the Error source.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getErrorSource)(const CMPIError*, CMPIStatus*);
	/** Returns a the format that the error src is in.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A error source format  code
	*/
    CMPIErrorSrcFormat (*getErrorSourceFormat)(const CMPIError*, CMPIStatus*);
	/** Returns a string which describes the 'other' format, only available if the error source is OTHER.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getOtherErrorSourceFormat)(const CMPIError*, CMPIStatus*);
	/** Returns the status code of this error.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A CMPI Status code
	*/
    CMPIrc (*getCIMStatusCode)(const CMPIError*, CMPIStatus*);
	/** Returns a string which describes the status code error.
		@param er Error this pointer
		@param rc Output: Service return status (suppressed when NULL).
		@return A string, which can be NULL
	*/
    CMPIString* (*getCIMStatusCodeDescription)(const CMPIError*, CMPIStatus*);
	/** Returns an array which contains the dynamic content of the message.
		@param er The Error this pointer
		@param rc Output: Serbice return status (surpressed when NULL)
		@return An array of CMPIStrings which represents the dynamic values
	*/
	CMPIArray* (*getMessageArguments)(const CMPIError*, CMPIStatus*);
	/** Sets the error type of this error object.
		@param er Error this pointer
		@param et The error type 
		@return Output: Service return status
	*/
    CMPIStatus (*setErrorType)(CMPIError*, const CMPIErrorType);
	/** 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
	*/
    CMPIStatus (*setOtherErrorType)(CMPIError*, const char *);
	/** Sets the description of the probable cause.
		@param er Error this pointer
		@param pc The probable cause string
		@return Output: Service return status
	*/
    CMPIStatus (*setProbableCauseDescription)(CMPIError*, const char *);
	/** 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
	*/
    CMPIStatus (*setRecommendedActions)(CMPIError*, const CMPIArray*);
	/** 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
	*/
    CMPIStatus (*setErrorSource)(CMPIError*, const char*);
	/** 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
	*/
    CMPIStatus (*setErrorSourceFormat)(CMPIError*, const CMPIErrorSrcFormat );
	/** 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
	*/
    CMPIStatus (*setOtherErrorSourceFormat)(CMPIError*, const char*);
	/** 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
	*/
    CMPIStatus (*setCIMStatusCodeDescription)(CMPIError*, const char*);
	/** 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
	*/
	CMPIStatus (*setMessageArguments)(CMPIError*, CMPIArray*);
  };
#   endif /* CMPI_VER_200 */


  //---------------------------------------------------
  //--
  //   _CMPIInstance Encapsulated object
  //--
  //---------------------------------------------------


   /** This structure represents the Encapsulated Instance object.
   */
  struct _CMPIInstance
  {