Difference between revisions of "Extensions.File.IsDirectory"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''IsDirectory'''}}Category:File == Classification == {{ClassificationActivity | IsDirectory | UPDATING... | Term | Extensions.File|OTX File exten...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''IsDirectory'''}}[[Category:File]]
 
{{DISPLAYTITLE:OTX '''IsDirectory'''}}[[Category:File]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | IsDirectory | UPDATING... | [[Term]] | [[Extensions.File|OTX File extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | IsDirectory| Determines whether the specified path exists and is a directory| [[Term]] | [[Extensions.File|OTX File extension]] | [[Extensions.File#Terms|File related Terms]]| - | - |}}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.CloseComChannel(ComChannelVariable);
+
BooleanTerm = File.IsDirectory(StringTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
The '''IsDirectory''' activity determines whether the specified path exists and is a directory.
−
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
 
−
{{ComChannelMemoryUsageNote}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if the specified path exists and is a directory.}}
−
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
 
−
-->
 
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| path| [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1..1] |The directory to check. The path parameter is permitted to specify relative or absolute path information.}}
 
|}
 
|}
−
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
String String1 = "";
 +
Boolean Boolean1 = false;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
String1 = File.CreateTempDirectory();
−
// ...
+
Boolean1 = File.IsDirectory(String1);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.File.CreateTempDirectory|CreateTempDirectory]]<br/>
 +
[[Extensions.File.GetFilePath|GetFilePath]]<br/>
 +
[[Extensions.File.GetFilesFromDirectory|GetFilesFromDirectory]]<br/>
 +
[[Extensions.File.GetFileSize|GetFileSize]]<br/>
 +
<!--[[Extensions.File.IsDirectory|IsDirectory]]<br/>-->
 +
[[Extensions.File.IsEndOfFileReached|IsEndOfFileReached]]<br/>
 +
[[Extensions.File.IsFile|IsFile]]<br/>
 +
[[Extensions.File.OpenFileForRead|OpenFileForRead]]<br/>
 +
[[Extensions.File.OpenFileForWrite|OpenFileForWrite]]<br/>
 +
[[Extensions.File.ReadBytes|ReadBytes]]<br/>
 +
[[Extensions.File.ReadFile|ReadFile]]<br/>
 +
[[Extensions.File.ReadLine|ReadLine]]

Revision as of 08:21, 27 September 2018

Classification

Name IsDirectory
Short Description Determines whether the specified path exists and is a directory
Class Term
Extension OTX File extension
Group File related Terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm = File.IsDirectory(StringTerm);

Description

The IsDirectory activity determines whether the specified path exists and is a directory.

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
Boolean Returns TRUE if the specified path exists and is a directory.

Properties

Name Data Type Class Default Cardinality Description
path String Term - [1..1] The directory to check. The path parameter is permitted to specify relative or absolute path information.

OTL Examples

String String1 = "";
Boolean Boolean1 = false;

/// Flow

String1 = File.CreateTempDirectory();
Boolean1 = File.IsDirectory(String1);

See also

CreateTempDirectory
GetFilePath
GetFilesFromDirectory
GetFileSize
IsEndOfFileReached
IsFile
OpenFileForRead
OpenFileForWrite
ReadBytes
ReadFile
ReadLine

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.File.IsDirectory&oldid=7275"