api1/pl.treksoft.kvision.cordova/get-file.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>getFile - kvision</title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">kvision</a>&nbsp;/&nbsp;<a href="index.html">pl.treksoft.kvision.cordova</a>&nbsp;/&nbsp;<a href="./get-file.html">getFile</a><br/>
<br/>
<h1>getFile</h1>
<a name="pl.treksoft.kvision.cordova$getFile(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)"></a>
<code><span class="keyword">suspend</span> <span class="keyword">fun </span><a href="-directory-entry/index.html"><span class="identifier">DirectoryEntry</span></a><span class="symbol">.</span><span class="identifier">getFile</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova$getFile(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)/path">path</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova$getFile(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)/create">create</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova$getFile(pl.treksoft.kvision.cordova.DirectoryEntry, kotlin.String, kotlin.Boolean, kotlin.Boolean)/exclusive">exclusive</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;false<span class="symbol">)</span><span class="symbol">: </span><a href="-result/index.html"><span class="identifier">Result</span></a><span class="symbol">&lt;</span><a href="-file-entry/index.html"><span class="identifier">FileEntry</span></a><span class="symbol">,</span>&nbsp;<a href="-file-exception/index.html"><span class="identifier">FileException</span></a><span class="symbol">&gt;</span></code>
<p>Get or create a file in a given parent directory.</p>
<h3>Parameters</h3>
<p><a name="path"></a>
<code>path</code> - target file path</p>
<p><a name="create"></a>
<code>create</code> - Used to indicate that the user wants to create a file if it was not previously there.</p>
<p><a name="exclusive"></a>
<code>exclusive</code> - Fail if the target path file already exists.</p>
</BODY>
</HTML>