IAttribute Class Reference

Provides access to members that return information for an Object attribute.
More...

#include <gdb_attribute.h>

Inheritance diagram for IAttribute:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetOwner (IObject **owner) const =0 throw ()
	Returns the owner of the attribute. More...
virtual GDBResult SDK_CALLTYPE	GetAttributeClassCode (AttributeClassCode &class_code) const =0 throw ()
	Returns the class code of the attribute. More...
virtual GDBResult SDK_CALLTYPE	GetType (AttributeType &attribute_type) const =0 throw ()
	Returns the type of the attribute. More...
virtual GDBResult SDK_CALLTYPE	GetValueType (AttributeValueType &value_type) const =0 throw ()
	Returns the type of the attribute value. More...
virtual GDBResult SDK_CALLTYPE	GetValue (SDKAny &value) const =0 throw ()
	Returns the value of the attribute. More...
virtual GDBResult SDK_CALLTYPE	GetAttributeValueRef (IAttributeValueRef **value_ref)=0 throw ()
	Gives direct access to the attribute value in the SENC data. More...
virtual GDBResult SDK_CALLTYPE	GetFlags (SDKUInt64 &flags)=0 throw ()
	Returns an attribute flags. Returns DateTimeFlags for the date/time types attribute value. More...
Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE	AddRef () const =0 throw ()
	Increments the reference count for an interface on a component.
virtual SDKAtomicRefCount SDK_CALLTYPE	Release () const =0 throw ()
	Decrements the reference count for an interface on a component.
virtual SDKResult SDK_CALLTYPE	GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
	Returns pointers to the supported interfaces on a component.
template<typename _Itf >
SDKResult	GetInterface (_Itf **obj_ptr) throw ()
	Returns pointers to the supported interfaces on a component.

Detailed Description

Provides access to members that return information for an Object attribute.

Member Function Documentation

GetOwner()

virtual GDBResult SDK_CALLTYPE GetOwner ( IObject **  owner ) const throw ( )

pure virtual

Returns the owner of the attribute.

Parameters

[out]

owner

Address of a variable that receives the pointer to the IObject interface associated with an object.

Returns

kSDKResult_Succeeded

kSDKResult_NotExist

GetAttributeClassCode()

virtual GDBResult SDK_CALLTYPE GetAttributeClassCode ( AttributeClassCode &  class_code ) const throw ( )

pure virtual

Returns the class code of the attribute.

Parameters

[out]

class_code

Address of a variable that receives the attribute class code.

Returns

kSDKResult_Succeeded

GetType()

virtual GDBResult SDK_CALLTYPE GetType ( AttributeType &  attribute_type ) const throw ( )

pure virtual

Returns the type of the attribute.

Parameters

[out]

attribute_type

Address of a variable that receives the attribute type.

Returns

kSDKResult_Succeeded.

GetValueType()

virtual GDBResult SDK_CALLTYPE GetValueType ( AttributeValueType &  value_type ) const throw ( )

pure virtual

Returns the type of the attribute value.

Parameters

[out]

value_type

Address of a variable that receives the attribute value type.

Returns

kSDKResult_Succeeded.

GetValue()

virtual GDBResult SDK_CALLTYPE GetValue ( SDKAny &  value ) const throw ( )

pure virtual

Returns the value of the attribute.

Parameters

[out]

value

Address of a variable that receives the attribute value.

Returns

kSDKResult_Succeeded.

kSDKResult_InternalError. Indicates a problem with the data.

GetAttributeValueRef()

virtual GDBResult SDK_CALLTYPE GetAttributeValueRef ( IAttributeValueRef **  value_ref ) throw ( )

pure virtual

Gives direct access to the attribute value in the SENC data.

Parameters

[out]

value_ref

Address of a variable that receives the pointer to the IAttributeValueRef interface.

Returns

kSDKResult_Succeeded

kSDKResult_InternalError.

GetFlags()

virtual GDBResult SDK_CALLTYPE GetFlags ( SDKUInt64 &  flags ) throw ( )

pure virtual

Returns an attribute flags. Returns DateTimeFlags for the date/time types attribute value.

Parameters

[out]

flags

Address of a variable that receives the attribute flags.

---

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

• gdb_attribute.h