Songbird / Development / Songbird Add-Ons API Documentation

sbIFileScan Interface Reference

The engine in which to execute sbIFileScanQuery objects. More...

import "sbIFileScan.idl";

List of all members.

Public Member Functions

void submitQuery (in sbIFileScanQuery pQuery)
 Execute a sbIFileScanQuery object.
PRInt32 scanDirectory (in AString strDirectory, in PRBool bRecurse, in sbIFileScanCallback pCallback)
 Execute a scan directly to a sbIFileScanCallback instance.


Detailed Description

The engine in which to execute sbIFileScanQuery objects.

Create a sbIFileScanQuery object, fill out its methods, create one of these and pass the query to the scanner to begin executing.

Optionally, you may skip the use of a sbIFileScanQuery object and just handle the scan directly by calling scanDirectory() with your own sbIFileScanCallback object.

See also:
sbIFileScanCallback, sbIFileScanQuery

Definition at line 265 of file sbIFileScan.idl.


Member Function Documentation

void sbIFileScan::submitQuery ( in sbIFileScanQuery  pQuery  ) 

Execute a sbIFileScanQuery object.

Parameters:
pQuery The query object to execute
See also:
scanDirectory

PRInt32 sbIFileScan::scanDirectory ( in AString  strDirectory,
in PRBool  bRecurse,
in sbIFileScanCallback  pCallback 
)

Execute a scan directly to a sbIFileScanCallback instance.

Parameters:
strDirectory The directory to scan
bRecurse Whether or not to recurse
pCallback The callback used to process the scan
See also:
submitQuery


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2