nsIFile:contains

From MDC

« XPCOM API Reference

Contents 1 Summary 2 Parameters 3 Return Values 4 See Also

[edit] Summary

This method tests whether or not a nsIFile instance is a descendent of the this nsIFile.

 boolean contains(
   in nsIFile aFile,
   in boolean aRecurse
 );

[edit] Parameters

aFile

[in] The nsIFile to test.

aRecurse

[in] This parameter specifies whether or not subdirectories should be inspected. As of Mozilla 1.7, this parameter is ignored and always treated as false by the canonical Local File implementation.

[edit] Return Values

This method returns true if aFile is a descendent of this nsIFile.

[edit] See Also

Local File, nsIFile