IIndexXRefLinkData Class Reference

#include <IIndexXRefLinkData.h>

Inheritance diagram for IIndexXRefLinkData:

Public Types
enum	{ kDefaultIID = IID_IINDEXXREFLINKDATA }

Public Member Functions
virtual const UID	GetTopicSectionUID () const =0
virtual void	SetTopicSectionUID (const UID topicSectionUID)=0
virtual const int32	GetNumBackXRefUIDs () const =0
virtual const UID	GetNthBackXRefUID (int32 id) const =0
virtual bool16	AddBackXRefUID (const UID backXRefUID)=0
virtual bool16	RemoveBackXRefUID (const UID backXRefUID)=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

Data interface used to hold information about cross-reference index links. The data stored contains the UID of the topic section which owns this entry and the UIDs of the cross-references that reference this entry.

Member Function Documentation

virtual bool16 IIndexXRefLinkData::AddBackXRefUID ( const UID  backXRefUID )

pure virtual

Adds a cross-reference to this topic.

Parameters

backXRefUID

[IN] - UID of the cross-reference that points to this topic.

Returns

kTrue if the cross-reference was successfully added.

virtual const UID IIndexXRefLinkData::GetNthBackXRefUID ( int32  id ) const

pure virtual

Gets the UID of the cross-reference at the specified index.

Returns

the UID of the cross-reference at the specified index.

virtual const int32 IIndexXRefLinkData::GetNumBackXRefUIDs ( ) const

pure virtual

Gets the number of cross-references to this topic.

Returns

the number of cross-references.

virtual const UID IIndexXRefLinkData::GetTopicSectionUID ( ) const

pure virtual

Gets the UID of the topic section that owns this topic.

Returns

the UIDRef of the topic section.

virtual bool16 IIndexXRefLinkData::RemoveBackXRefUID ( const UID  backXRefUID )

pure virtual

Removes a cross-reference to this topic.

Parameters

backXRefUID

[IN] - UID of the cross-reference to be removed.

Returns

kTrue if the cross-reference was successfully removed.

virtual void IIndexXRefLinkData::SetTopicSectionUID ( const UID  topicSectionUID )

pure virtual

Sets the UID of the topic section that owns this topic.

Parameters

topicSectionUID

[IN] - the UIDRef of the topic section.