CmpiArgs Class Reference

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

#include <CmpiArgs.h>

Inheritance diagram for CmpiArgs:

[legend]Collaboration diagram for CmpiArgs:

[legend]List of all members.

Public Member Functions
	CmpiArgs ()
	Constructor - Empty argument container.
unsigned int	getArgCount ()
	getArgCount - Gets the number of arguments defined for this argument container.
CmpiData	getArg (const char *name)
	getArg - Gets the CmpiData object representing the value associated with the argument name
CmpiData	getArg (const int index, CmpiString *name=NULL)
	getArgument - Gets the CmpiData object defined by the input index parameter.
void	setArg (const char *name, CmpiData &data)
	setArg - adds/replaces an argument value defined by the input parameter to the container.
Protected Member Functions
	CmpiArgs (CMPIArgs *enc)
	Protected constructor used by MIDrivers to encapsulate CMPIArgs.
CMPIArgs *	getEnc () const
	Gets the encapsulated CMPIArgs.
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.

Definition at line 37 of file CmpiArgs.h.

---

Constructor & Destructor Documentation

CmpiArgs::CmpiArgs (  CMPIArgs *  enc  )  [inline, protected]

Protected constructor used by MIDrivers to encapsulate CMPIArgs. Definition at line 44 of file CmpiArgs.h. References CmpiObject::enc.

CmpiArgs::CmpiArgs (   )  [inline]

Constructor - Empty argument container. Definition at line 57 of file CmpiArgs.h. References CmpiObject::enc, CmpiProviderBase::getBroker(), and makeArgs().

---

Member Function Documentation

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

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. Definition at line 1094 of file CmpiImpl.cpp. References CMPI_RC_OK, CmpiData::data, _CMPIArgs::ft, _CMPIArgsFT::getArgAt, getEnc(), name, _CMPIStatus::rc, and s.

CmpiData CmpiArgs::getArg (  const char *  name  )

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. Definition at line 1104 of file CmpiImpl.cpp. References CMPI_RC_OK, CmpiData::data, _CMPIArgs::ft, _CMPIArgsFT::getArg, getEnc(), and _CMPIStatus::rc.

unsigned int CmpiArgs::getArgCount (   )

getArgCount - Gets the number of arguments defined for this argument container. Returns: Number of arguments in this container. Definition at line 1112 of file CmpiImpl.cpp. References CMPI_RC_OK, _CMPIArgs::ft, _CMPIArgsFT::getArgCount, getEnc(), and _CMPIStatus::rc.

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

Gets the encapsulated CMPIArgs. Definition at line 49 of file CmpiArgs.h. References CmpiObject::enc. Referenced by getArg(), getArgCount(), and setArg().

void * CmpiArgs::makeArgs (  CMPIBroker *  mb  )  [protected]

Definition at line 1079 of file CmpiImpl.cpp. References CMPI_RC_OK, _CMPIBroker::eft, _CMPIBrokerEncFT::newArgs, and _CMPIStatus::rc. Referenced by CmpiArgs().

void CmpiArgs::setArg (  const char *  name, 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. Definition at line 1086 of file CmpiImpl.cpp. References _CMPIArgsFT::addArg, _CMPIValue::chars, CMPI_chars, CMPI_RC_OK, CmpiData::data, _CMPIArgs::ft, getEnc(), _CMPIStatus::rc, _CMPIData::type, and _CMPIData::value.

---

Friends And Related Function Documentation

friend class CmpiBroker [friend]

Reimplemented from CmpiObject. Definition at line 38 of file CmpiArgs.h.

friend class CmpiMethodMI [friend]

Definition at line 39 of file CmpiArgs.h.

---

The documentation for this class was generated from the following files:

• CmpiArgs.h
• CmpiImpl.cpp

---