ILinkObjectReference Class Reference

#include <ILinkObjectReference.h>

Inheritance diagram for ILinkObjectReference:

Public Types
enum	{ kDefaultIID = IID_ILINKOBJECTREFERENCE }

Public Member Functions
virtual void	SetUID (UID id)=0
virtual UID	GetUID () const =0
virtual bool16	IsDirectReference () const =0
virtual IPMUnknown *	QueryLinkedObject (const PMIID &iid, const UID &uid=kInvalidUID) const =0
virtual void	ReadWrite (IPMStream *iPMStream, ImplementationID id)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

A data interface to allow links to access linked object.

Member Function Documentation

virtual UID ILinkObjectReference::GetUID ( ) const

pure virtual

Return the stored UID

virtual bool16 ILinkObjectReference::IsDirectReference ( ) const

pure virtual

Return if this is a direct reference (the stored uid specifies the linked object) or an indirect reference (the stored uid specifies a reference object, which points to the linked object)

Returns

bool16 kTrue for direct reference, kFalse for indirect reference.

virtual IPMUnknown* ILinkObjectReference::QueryLinkedObject ( const PMIID &  iid, const UID &  uid = kInvalidUID  ) const

pure virtual

Query interface on the linked object. Client code should use this method to access the linked object.

Parameters

iid	IN interested interface ID
UID	of the linked object (for direct reference) or the reference object (for indirect reference). The method uses the stored UID if uid is kInvalidUID (default).

Returns

IPMUnkown The requested interface if the object supports it. Nil otherwise. AddRef is called on the interface, caller should release it. Returns nil if the link hasn't been instantiated.

virtual void ILinkObjectReference::ReadWrite ( IPMStream *  iPMStream, ImplementationID  id  )

pure virtual

Method to serialise object to or deserialise object from given stream

Parameters

iPMStream	IN stream to read state from or write state to
id	IN the implementation ID of the steam data

virtual void ILinkObjectReference::SetUID ( UID  id )

pure virtual

Set the UID stored in the interface.

Parameters

id	IN specifies the uid of the linked object (for direct reference ) or a reference object (for indirect reference)