IRelationshipCollection Class Reference

Provides access to relationship collection. More...

#include <gdb_relationship.h>

Inheritance diagram for IRelationshipCollection:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetRelationshipCount (SDKUInt32 &count) const =0 throw ()
	Returns the number of relationships in the collection. More...
virtual GDBResult SDK_CALLTYPE	GetRelationship (SDKUInt32 index, IObject **related_object, RelationshipClass *relationship_class, RelationshipRole *relationship_role) const =0 throw ()
	Returns the relationship from the relationship collection specified by index. The first relationship has index 0 and the last relationship has index equal to RelationshipCount - 1. More...
virtual GDBResult SDK_CALLTYPE	GetRelationshipObject (SDKUInt32 index, IRelationship **relationship) const =0 throw ()
	Returns the relationship object from the relationship collection specified by index. The first relationship has index 0 and the last relationship has index equal to RelationshipCount - 1. 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 relationship collection.

Member Function Documentation

GetRelationshipCount()

virtual GDBResult SDK_CALLTYPE GetRelationshipCount ( SDKUInt32 &  count ) const throw ( )

pure virtual

Returns the number of relationships in the collection.

Parameters

[out]

count

Number of relationships in the collection.

Returns

kSDKResult_Succeeded

GetRelationship()

virtual GDBResult SDK_CALLTYPE GetRelationship ( SDKUInt32  index, IObject **  related_object, RelationshipClass *  relationship_class, RelationshipRole *  relationship_role  ) const throw ( )

pure virtual

Returns the relationship from the relationship collection specified by index. The first relationship has index 0 and the last relationship has index equal to RelationshipCount - 1.

Parameters

[in]	index	Index in the relationship collection.
[out]	related_object	Address of a variable that receives the pointer to the related object.
[out]	relationship_class	Address of a variable that receives the class of the relationship. It can be NULL.
[out]	relationship_role	Address of a variable that receives the role of the related object. It can be NULL.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotFound

GetRelationshipObject()

virtual GDBResult SDK_CALLTYPE GetRelationshipObject ( SDKUInt32  index, IRelationship **  relationship  ) const throw ( )

pure virtual

Returns the relationship object from the relationship collection specified by index. The first relationship has index 0 and the last relationship has index equal to RelationshipCount - 1.

Parameters

[in]	index	Index in the relationship collection.
[out]	relationship	Address of a variable that receives the pointer to the IRelationship interface associated with the related object.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotFound

---

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

• gdb_relationship.h