Songbird / Development / Songbird Add-Ons API Documentation

sbITemporaryFileService Interface Reference

import "sbITemporaryFileService.idl";

List of all members.

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.

Public Attributes

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


Detailed Description

The sbITemporaryFileService interface provides support for creating temporary files and directories. These files and directories are deleted when the application quits.

"@songbirdnest.com/Songbird/TemporaryFileService;1" Use get service with this component.

Definition at line 45 of file sbITemporaryFileService.idl.


Member Function Documentation

nsIFile sbITemporaryFileService::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:
aType Type of file to create. One of nsIFile file types.
aBaseName Optional file base name.
aExtension Optional file extension.


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