InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IRIDXQuery Class Referenceabstract

#include <IRIDX.h>

Inheritance diagram for IRIDXQuery:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IRIDXQUERY }
 

Public Member Functions

virtual IDataBase * GetDataBase ()=0
 
virtual void StartTarget (RIDXTarget target)=0
 
virtual bool GetNextSource (RIDXSource &source)=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

Query object to use to interrogate the reference index.

Created by IRIDX::CreateQuery(), an instance of this boss object represents an active query on a reference index. It can be used to find out what sources reference specified targets.

Member Function Documentation

virtual IDataBase* IRIDXQuery::GetDataBase ()
pure virtual

Returns the database holding the reference index on which the query is running.

Returns
the database holding the reference index on which the query is running.
virtual bool IRIDXQuery::GetNextSource (RIDXSource & source)
pure virtual

Gets the next source that references the target previously specified by calling StartTarget().

Parameters
sourceis where to return the next source
Returns
true if there was another source, false otherwise
virtual void IRIDXQuery::StartTarget (RIDXTarget target)
pure virtual

Sets up the query object (initializes an iterator) to begin enumerating sources for that reference a target. After calling StartTarget(), call GetNextSource() repeatedly to get the sources referencing the specified target.

Parameters
targetis the target to start enumerating sources for