sbITemporaryFileFactory Interface Reference

import"sbITemporaryFileFactory.idl";

Inheritance diagram for sbITemporaryFileFactory:
[legend]
Collaboration diagram for sbITemporaryFileFactory:
[legend]

Public Member Functions

nsIFile createFile (in unsigned long aType, [optional] in AString aBaseName, [optional] in AString aExtension)
 Create and return a new and unique temporary file of the type specified by aType. If aBaseName is specified, use aBaseName as the base name of the file. If aExtension is specified, use aExtension as the file extension. More...
 
void clear ()
 Clear all temporary files and directories. More...
 

Public Attributes

attribute nsIFile rootTemporaryDirectory
 Root directory of temporary files and directories. More...
 

Detailed Description

The sbITemporaryFileFactory interface provides support for creating temporary files and directories. These files and directories are deleted when the temporary file factory is destroyed.

"@songbirdnest.com/Songbird/TemporaryFileFactory;1" Use create instance with this component.

This component creates its own temporary directory which it uses as the parent directory of all created temporary files. When this component is destroyed the temporary directory is deleted.

Definition at line 47 of file sbITemporaryFileFactory.idl.

Member Function Documentation

void sbITemporaryFileFactory::clear ( )

Clear all temporary files and directories.

nsIFile sbITemporaryFileFactory::createFile ( in unsigned long  aType,
[optional] in AString  aBaseName,
[optional] in AString  aExtension 
)

Create and return a new and unique temporary file of the type specified by aType. If aBaseName is specified, use aBaseName as the base name of the file. If aExtension is specified, use aExtension as the file extension.

Parameters
aTypeType of file to create. One of nsIFile file types.
aBaseNameOptional file base name.
aExtensionOptional file extension.

Member Data Documentation

attribute nsIFile sbITemporaryFileFactory::rootTemporaryDirectory

Root directory of temporary files and directories.

Definition at line 53 of file sbITemporaryFileFactory.idl.


The documentation for this interface was generated from the following file: