_CMPIArgsFT Struct Reference

#include <cmpi/cmpift.h>

List of all members.

Public Attributes
int	ftVersion
CMPIStatus(*	release )(CMPIArgs *as)
CMPIArgs *(*	clone )(const CMPIArgs *as, CMPIStatus *rc)
CMPIStatus(*	addArg )(const CMPIArgs *as, const char *name, const CMPIValue *value, const CMPIType type)
CMPIData(*	getArg )(const CMPIArgs *as, const char *name, CMPIStatus *rc)
CMPIData(*	getArgAt )(const CMPIArgs *as, CMPICount index, CMPIString **name, CMPIStatus *rc)
CMPICount(*	getArgCount )(const CMPIArgs *as, CMPIStatus *rc)

---

Detailed Description

This structure is a table of pointers providing access to Args support sevices.

---

Member Data Documentation

int _CMPIArgsFT::ftVersion

Function table version

CMPIStatus(* _CMPIArgsFT::release)(CMPIArgs *as)

The Args object will not be used any further and may be freed by CMPI run time system.

Parameters:

as

Args this pointer.

Returns:

Service return status.

CMPIArgs*(* _CMPIArgsFT::clone)(const CMPIArgs *as, CMPIStatus *rc)

Create an independent copy of this Args object. The resulting object must be released explicitly.

Parameters:

	as	Args this pointer.
	rc	Output: Service return status (suppressed when NULL).

Returns:

Pointer to copied Args object.

CMPIStatus(* _CMPIArgsFT::addArg)(const CMPIArgs *as, const char *name, const CMPIValue *value, const CMPIType type)

Adds/replaces a named argument.

Parameters:

	as	Args this pointer.
	name	Argument name.
	value	Address of value structure.
	type	Value type.

Returns:

Service return status.

Referenced by CmpiArgs::setArg().

CMPIData(* _CMPIArgsFT::getArg)(const CMPIArgs *as, const char *name, CMPIStatus *rc)

Gets a named argument value.

Parameters:

	as	Args this pointer.
	name	Argument name.
	rc	Output: Service return status (suppressed when NULL).

Returns:

Argument value.

Referenced by CmpiArgs::getArg().

CMPIData(* _CMPIArgsFT::getArgAt)(const CMPIArgs *as, CMPICount index, CMPIString **name, CMPIStatus *rc)

Gets a Argument value defined by its index.

Parameters:

	as	Args this pointer.
	index	Position in the internal Data array.
	name	Output: Returned argument name (suppressed when NULL).
	rc	Output: Service return status (suppressed when NULL).

Returns:

Argument value.

Referenced by CmpiArgs::getArg().

CMPICount(* _CMPIArgsFT::getArgCount)(const CMPIArgs *as, CMPIStatus *rc)

Gets the number of arguments contained in this Args.

Parameters:

	as	Args this pointer.
	rc	Output: Service return status (suppressed when NULL).

Returns:

Number of properties.

Referenced by CmpiArgs::getArgCount().

---

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

• cmpi/cmpift.h