|
LibreOffice Module unotools (master) 1
|
The class TempFile gives access to temporary files in the local file system. More...
#include <tempfile.hxx>
Public Member Functions | |
| TempFileNamed (const OUString *pParent=nullptr, bool bDirectory=false) | |
| Create a temporary file or directory, in the default tempfile folder or if possible in a given folder. More... | |
| TempFileNamed (std::u16string_view rLeadingChars, bool _bStartWithZero=true, std::u16string_view pExtension={}, const OUString *pParent=nullptr, bool bCreateParentDirs=false) | |
| Same as above; additionally the name starts with some given characters followed by a counter ( example: rLeadingChars="abc" means "abc0","abc1" and so on, depending on existing files in the folder ). More... | |
| TempFileNamed (TempFileNamed &&other) noexcept | |
| ~TempFileNamed () | |
| TempFile will be removed from disk in dtor if EnableKillingFile(true) was called before. More... | |
| bool | IsValid () const |
| Returns sal_True if it has a valid file name. More... | |
| OUString const & | GetURL () const |
| Returns the URL of the tempfile object. More... | |
| OUString | GetFileName () const |
| Returns the system path name of the tempfile in host notation If you want to have the URL, use the GetURL() method of this object. More... | |
| SvStream * | GetStream (StreamMode eMode) |
| Returns a stream to the tempfiles data; the stream is owned by the tempfile object, so you have to keep this alive as long as you want to use the stream. More... | |
| void | CloseStream () |
| Let the TempFile object close and destroy the owned stream object if any. More... | |
| void | EnableKillingFile (bool bEnable=true) |
| If enabled the file will be removed from disk when the dtor is called ( default is not enabled ) More... | |
Private Attributes | |
| OUString | aName |
| std::unique_ptr< SvStream > | pStream |
| bool | bIsDirectory |
| bool | bKillingFileEnabled |
Friends | |
| UNOTOOLS_DLLPUBLIC OUString | SetTempNameBaseDirectory (const OUString &) |
| The TempNameBaseDirectory is a subfolder in the folder that is passed as a "physical" file name in the SetTempNameBaseDirectory method. More... | |
The class TempFile gives access to temporary files in the local file system.
Sometimes they are needed because a 3rd party code has a file name based interface, or some file access has to be done locally without transferring tons of bytes to or from a remote system. Creating a UCB content on a TempFile is only possible if a UCP for the local file system is present. TempFiles can always be accessed by SvFileStreams or Sot/SvStorages using the "physical" file name ( not the URL, because this may be a non-file URL, see below ), but if a UCB content can be created, it is also possible to take the URL and use the UCB helper classes for streams. For convenience use UcbStreamHelper. A Tempfile always has a "physical" file name ( a file name in the local computers host notation ) but it has a "UCB compatible" URL only if a UCP for the local file system exists. This URL may have its own URL scheme ( not necessarily "file://" ! ). The TempFile class methods take this into account, but other simple conversions like the osl functions do not. So it is a potential error to convert between the filename and the URL of a TempFile object using functions or methods outside this class.
Definition at line 119 of file tempfile.hxx.
| utl::TempFileNamed::TempFileNamed | ( | const OUString * | pParent = nullptr, |
| bool | bDirectory = false |
||
| ) |
Create a temporary file or directory, in the default tempfile folder or if possible in a given folder.
This given folder ( the "parent" parameter ( if not NULL ) ) must be a "UCB compatible" URL. The temporary object is created in the local file system, even if there is no UCB that can access it. If the given folder is part of the local file system, the TempFile is created in this folder.
Definition at line 453 of file tempfile.cxx.
References aName, and utl::CreateTempName_Impl().
| utl::TempFileNamed::TempFileNamed | ( | std::u16string_view | rLeadingChars, |
| bool | _bStartWithZero = true, |
||
| std::u16string_view | pExtension = {}, |
||
| const OUString * | pParent = nullptr, |
||
| bool | bCreateParentDirs = false |
||
| ) |
Same as above; additionally the name starts with some given characters followed by a counter ( example: rLeadingChars="abc" means "abc0","abc1" and so on, depending on existing files in the folder ).
The extension string may be f.e. ".txt" or "", if no extension string is given, ".tmp" is used
| _bStartWithZero | If set to false names will be generated like "abc","abc0","abc1" |
| bCreateParentDirs | If rLeadingChars contains a slash, this will create the required parent directories. |
Definition at line 460 of file tempfile.cxx.
References aName, utl::lcl_createName(), and t.
|
noexcept |
Definition at line 471 of file tempfile.cxx.
References aName.
| utl::TempFileNamed::~TempFileNamed | ( | ) |
TempFile will be removed from disk in dtor if EnableKillingFile(true) was called before.
Temporary directories will be removed recursively in that case.
Definition at line 478 of file tempfile.cxx.
References aName, bIsDirectory, bKillingFileEnabled, comphelper::DirectoryHelper::deleteDirRecursively(), and pStream.
| void utl::TempFileNamed::CloseStream | ( | ) |
Let the TempFile object close and destroy the owned stream object if any.
Definition at line 531 of file tempfile.cxx.
References pStream.
|
inline |
If enabled the file will be removed from disk when the dtor is called ( default is not enabled )
Definition at line 188 of file tempfile.hxx.
| OUString utl::TempFileNamed::GetFileName | ( | ) | const |
Returns the system path name of the tempfile in host notation If you want to have the URL, use the GetURL() method of this object.
Definition at line 499 of file tempfile.cxx.
References aName.
| SvStream * utl::TempFileNamed::GetStream | ( | StreamMode | eMode | ) |
Returns a stream to the tempfiles data; the stream is owned by the tempfile object, so you have to keep this alive as long as you want to use the stream.
If the TempFile object is destroyed, it also destroys the stream object, the underlying file is only deleted if EnableKillingFile(true) has been called before!
Definition at line 518 of file tempfile.cxx.
| OUString const & utl::TempFileNamed::GetURL | ( | ) | const |
Returns the URL of the tempfile object.
If you want to have the system path file name, use the GetFileName() method of this object
Definition at line 506 of file tempfile.cxx.
| bool utl::TempFileNamed::IsValid | ( | ) | const |
Returns sal_True if it has a valid file name.
Definition at line 494 of file tempfile.cxx.
References aName.
|
friend |
The TempNameBaseDirectory is a subfolder in the folder that is passed as a "physical" file name in the SetTempNameBaseDirectory method.
This subfolder will be used if a TempFile or TempName is created without a parent name or a parent name that does not belong to the local file system. The caller of the SetTempNameBase is responsible for deleting this folder and all temporary files in it. The return value of both methods is the complete "physical" name of the tempname base folder. It is not a URL because all URLs must be "UCB compatible", so there may be no suitable URL at all.
Definition at line 536 of file tempfile.cxx.
|
private |
Definition at line 122 of file tempfile.hxx.
Referenced by GetFileName(), GetStream(), GetURL(), IsValid(), TempFileNamed(), and ~TempFileNamed().
|
private |
Definition at line 125 of file tempfile.hxx.
Referenced by ~TempFileNamed().
|
private |
Definition at line 126 of file tempfile.hxx.
Referenced by ~TempFileNamed().
|
private |
Definition at line 124 of file tempfile.hxx.
Referenced by CloseStream(), GetStream(), GetURL(), and ~TempFileNamed().
1.9.3