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

#include <ILibraryAssetIterator.h>

Public Member Functions

virtual ILibraryAsset * First ()=0
 
virtual ILibraryAsset * Next ()=0
 
virtual ILibraryAsset * Find (LibraryAssetID assetID)=0
 
virtual bool16 PassesThrough (LibraryAssetID assetID, ILibraryComplexFilterData *inFilter)=0
 

Detailed Description

This is a standard C class used to iterate over the assets in a library. Not a standard boss interface.

See Also
ILibraryAsset
ILibraryComplexFilterData

Member Function Documentation

virtual ILibraryAsset* ILibraryAssetIterator::Find (LibraryAssetID assetID)
pure virtual

Find an asset by its LibraryAssetID

Parameters
assetIDIN the LibraryAssetID for the asset to find
Returns
an ILibraryAsset interface pointer; must be released by calling ILibraryAssetCollection::ReleaseAsset when the client is done with it.
virtual ILibraryAsset* ILibraryAssetIterator::First ()
pure virtual

Initialize internal state & return the first asset of the collection.

Returns
an ILibraryAsset interface pointer; must be released by calling ILibraryAssetCollection::ReleaseAsset when the client is done with it.
virtual ILibraryAsset* ILibraryAssetIterator::Next ()
pure virtual

Move to the next asset of the collection.

Returns
an ILibraryAsset interface pointer; must be released by calling ILibraryAssetCollection::ReleaseAsset when the client is done with it.
virtual bool16 ILibraryAssetIterator::PassesThrough (LibraryAssetID assetID,
ILibraryComplexFilterData * inFilter 
)
pure virtual

Tell whether an asset is found using a filter.

Parameters
assetIDIN the asset to search for
inFilterIN the filter to use
Returns
kTrue if the asset is found, kFalse otherwise