Difference between revisions of "Extensions.File.CreateTempDirectory"

From emotive
Jump to navigation Jump to search
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
/// Local Declarations
+
StringTerm File.CreateTempDirectory();
String StringVariable = "";
 
/// Flow
 
StringVariable = File.CreateTempDirectory();
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
 
The '''CreateTempDirectory''' activity creates a new unique temporary directory and returns the URI of the path, which is either absolute or relative to OTX home. The OTX runtime environment has to deliver such directory and has to ensure that the user has read and write access to the content of that directory. After finishing the execution of the OTX runtime, the temporary directory will be deleted automatically with all its contents.
 
The '''CreateTempDirectory''' activity creates a new unique temporary directory and returns the URI of the path, which is either absolute or relative to OTX home. The OTX runtime environment has to deliver such directory and has to ensure that the user has read and write access to the content of that directory. After finishing the execution of the OTX runtime, the temporary directory will be deleted automatically with all its contents.
 +
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The URI of the path}}
  
 
== Properties ==
 
== Properties ==
 
* NONE
 
* NONE
<!--{| {{TableHeader}}
+
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertie1| handle| [[Extensions.File.FileWriteHandle|FileWriteHandle]] | [[Term]] | - | [1..1] | The handle for the file that the related file object encapsulates.}}
 
{{TableRowPropertie2| value| [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1..1] | The string to write to the file. The string can contain line breaks, which will be written without any operation system specific conversion.}}
 
|}
 
-->
 
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">

Revision as of 10:06, 2 November 2018

Classification

Name CreateTempDirectory
Short Description Creates a new unique temporary directory
Class Term
Extension OTX File extension
Group File related Terms
Exceptions FileSaveException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm File.CreateTempDirectory();

Description

The CreateTempDirectory activity creates a new unique temporary directory and returns the URI of the path, which is either absolute or relative to OTX home. The OTX runtime environment has to deliver such directory and has to ensure that the user has read and write access to the content of that directory. After finishing the execution of the OTX runtime, the temporary directory will be deleted automatically with all its contents.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String The URI of the path

Properties

  • NONE

OTL Examples

/// Local Declarations

String String1 = "";

/// Flow

String1 = File.CreateTempDirectory();

See also

GetFilePath
GetFilesFromDirectory
GetFileSize
IsDirectory
IsEndOfFileReached
IsFile
OpenFileForRead
OpenFileForWrite
ReadBytes
ReadFile
ReadLine