CmpiArgs Class Reference

#include <cmpi/CmpiArgs.h>

Inheritance diagram for CmpiArgs:
CmpiObject

List of all members.

Public Member Functions

 CmpiArgs ()
unsigned int getArgCount () const
CmpiData getArg (const char *name) const
CmpiData getArg (const int index, CmpiString *name=NULL) const
void setArg (const char *name, const CmpiData &data)

Protected Member Functions

 CmpiArgs (CMPIArgs *enc)
CMPIArgsgetEnc () const
void * makeArgs (CMPIBroker *mb)

Friends

class CmpiBroker
class CmpiMethodMI

Detailed Description

This class wraps a CIMOM specific input and output arguments passed to methodInvocation functions.


Constructor & Destructor Documentation

CmpiArgs::CmpiArgs ( CMPIArgs enc  )  [protected]

Protected constructor used by MIDrivers to encapsulate CMPIArgs.

CmpiArgs::CmpiArgs (  ) 

Constructor - Empty argument container.

References CmpiObject::enc, CmpiProviderBase::getBroker(), and makeArgs().


Member Function Documentation

CmpiData CmpiArgs::getArg ( const int  index,
CmpiString name = NULL 
) const

getArgument - Gets the CmpiData object defined by the input index parameter.

Parameters:
index Index into the argument array.
name Optional output parameter returning the argument name.
Returns:
CmpiData value object corresponding to the index.

References CmpiData::_data, CmpiString::charPtr(), CMPI_RC_ERR_NOT_FOUND, CMPI_RC_OK, _CMPIArgs::ft, _CMPIArgsFT::getArgAt, getEnc(), _CMPIStatus::msg, and _CMPIStatus::rc.

CmpiData CmpiArgs::getArg ( const char *  name  )  const

getArg - Gets the CmpiData object representing the value associated with the argument name

Parameters:
name argument name.
Returns:
CmpiData value object associated with the argument.

References CmpiData::_data, CMPI_RC_ERR_NOT_FOUND, CMPI_RC_OK, _CMPIArgs::ft, _CMPIArgsFT::getArg, getEnc(), _CMPIStatus::msg, and _CMPIStatus::rc.

unsigned int CmpiArgs::getArgCount (  )  const

getArgCount - Gets the number of arguments defined for this argument container.

Returns:
Number of arguments in this container.

References CMPI_RC_OK, _CMPIArgs::ft, _CMPIArgsFT::getArgCount, getEnc(), and _CMPIStatus::rc.

CMPIArgs * CmpiArgs::getEnc (  )  const [protected]

Gets the encapsulated CMPIArgs.

References CmpiObject::enc.

Referenced by getArg(), getArgCount(), and setArg().

void * CmpiArgs::makeArgs ( CMPIBroker mb  )  [protected]
void CmpiArgs::setArg ( const char *  name,
const CmpiData data 
)

setArg - adds/replaces an argument value defined by the input parameter to the container.

Parameters:
name Property name.
data Type and Value to be added.

References CmpiData::_data, _CMPIArgsFT::addArg, _CMPIValue::chars, CMPI_chars, CMPI_RC_OK, _CMPIArgs::ft, getEnc(), _CMPIStatus::rc, _CMPIData::type, and _CMPIData::value.


Friends And Related Function Documentation

friend class CmpiBroker [friend]

Reimplemented from CmpiObject.

friend class CmpiMethodMI [friend]

The documentation for this class was generated from the following files:
Generated on Mon Jul 5 13:09:52 2010 for cmpi by  doxygen 1.6.3