Property Class Reference
[C++ wrapper]

Property class. More...

#include <netppplus.h>

Public Member Functions
uint32_t	getToken ()
	Returns device token.
struct DCDevice *	getDevice ()
	Returns associated device.
int	getName (std::string &s)
	Retrieves property local name into string s.
Property	getChild (void)
	Returns first child of this property.
Property	getNext (Property &prev)
	Returns following sibling of given property.
int	getProto (Value &val)
	Get Value prototype from peer.
int	getValue (Value &val)
	Retrieves the property value.
int	setValue (Value &val)
	Sets the property value.
bool	isValid ()
	Returns true, if the Property is valid.

---

Detailed Description

This consists of a device handle and a property token

---

Member Function Documentation

Property getChild

(

void

)

[inline]

Returns:

A property which must be validated against a NIL property using isValid().

Property getNext

(

Property &

prev

)

[inline]

Parameters:

prev

The previously selected property in the children hierarchy.

Returns:

A property which must be validated against a NIL property using isValid().

Exceptions:

A

netpp error code

int getProto

(

Value &

val

)

Fills in data types and lengths of value, but does not yet read the value. Used to determine the data type.

Returns:

A netpp error code

References dcProperty_GetProto().

int getValue

(

Value &

val

)

Note that in case of a DC_BUFFER or DC_STRING property, the Value must be preinitialized.

Returns:

A netpp error code

References dcDevice_GetProperty().

bool isValid

(

)

[inline]

References INVALID_TOKEN.

int setValue

(

Value &

val

)

Parameters:

val

The preinitialized Value

References dcDevice_SetProperty().

---

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

• netppplus.h
• netppplus.cpp