-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcep.fs.readFile.html
441 lines (224 loc) · 12.1 KB
/
cep.fs.readFile.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Adobe CEP8 API Class: readFile</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.united.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Adobe CEP8 API</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="cep.encoding.convertion.html">cep.encoding.convertion</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="AgoraLib.html">AgoraLib</a></li><li><a href="ApiVersion.html">ApiVersion</a></li><li><a href="AppSkinInfo.html">AppSkinInfo</a></li><li><a href="cep.fs.chmod.html">cep.fs.chmod</a></li><li><a href="cep.fs.deleteFile.html">cep.fs.deleteFile</a></li><li><a href="cep.fs.makedir.html">cep.fs.makedir</a></li><li><a href="cep.fs.readdir.html">cep.fs.readdir</a></li><li><a href="cep.fs.readFile.html">cep.fs.readFile</a></li><li><a href="cep.fs.rename.html">cep.fs.rename</a></li><li><a href="cep.fs.showOpenDialog.html">cep.fs.showOpenDialog</a></li><li><a href="cep.fs.showOpenDialogEx.html">cep.fs.showOpenDialogEx</a></li><li><a href="cep.fs.showSaveDialogEx.html">cep.fs.showSaveDialogEx</a></li><li><a href="cep.fs.stat.html">cep.fs.stat</a></li><li><a href="cep.fs.writeFile.html">cep.fs.writeFile</a></li><li><a href="cep.process.createProcess.html">cep.process.createProcess</a></li><li><a href="cep.process.getWorkingDirectory.html">cep.process.getWorkingDirectory</a></li><li><a href="cep.process.isRunning.html">cep.process.isRunning</a></li><li><a href="cep.process.onquit.html">cep.process.onquit</a></li><li><a href="cep.process.stderr.html">cep.process.stderr</a></li><li><a href="cep.process.stdin.html">cep.process.stdin</a></li><li><a href="cep.process.stdout.html">cep.process.stdout</a></li><li><a href="cep.process.terminate.html">cep.process.terminate</a></li><li><a href="cep.process.waitfor.html">cep.process.waitfor</a></li><li><a href="cep.util.openURLInDefaultBrowser.html">cep.util.openURLInDefaultBrowser</a></li><li><a href="cep.util.registerExtensionUnloadCallback.html">cep.util.registerExtensionUnloadCallback</a></li><li><a href="cep.util.storeProxyCredentials.html">cep.util.storeProxyCredentials</a></li><li><a href="ColorType.html">ColorType</a></li><li><a href="ContextMenuItemStatus.html">ContextMenuItemStatus</a></li><li><a href="CSEvent.html">CSEvent</a></li><li><a href="CSInterface.html">CSInterface</a></li><li><a href="Direction.html">Direction</a></li><li><a href="Extension.html">Extension</a></li><li><a href="GradientColor.html">GradientColor</a></li><li><a href="GradientStop.html">GradientStop</a></li><li><a href="HostCapabilities.html">HostCapabilities</a></li><li><a href="HostEnvironment.html">HostEnvironment</a></li><li><a href="MenuItemStatus.html">MenuItemStatus</a></li><li><a href="RGBColor.html">RGBColor</a></li><li><a href="Runtime.html">Runtime</a></li><li><a href="SystemPath.html">SystemPath</a></li><li><a href="UIColor.html">UIColor</a></li><li><a href="Version.html">Version</a></li><li><a href="VersionBound.html">VersionBound</a></li><li><a href="VersionRange.html">VersionRange</a></li><li><a href="Vulcan.html">Vulcan</a></li><li><a href="VulcanMessage.html">VulcanMessage</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#AgoraLibResponse">AgoraLibResponse</a></li><li><a href="global.html#cep">cep</a></li><li><a href="global.html#CSXSWindowType">CSXSWindowType</a></li><li><a href="global.html#DEPRECATED_API">DEPRECATED_API</a></li><li><a href="global.html#ERR_CANT_READ">ERR_CANT_READ</a></li><li><a href="global.html#ERR_CANT_WRITE">ERR_CANT_WRITE</a></li><li><a href="global.html#ERR_EXCEED_MAX_NUM_PROCESS">ERR_EXCEED_MAX_NUM_PROCESS</a></li><li><a href="global.html#ERR_FILE_EXISTS">ERR_FILE_EXISTS</a></li><li><a href="global.html#ERR_INVALID_PARAMS">ERR_INVALID_PARAMS</a></li><li><a href="global.html#ERR_INVALID_URL">ERR_INVALID_URL</a></li><li><a href="global.html#ERR_NOT_DIRECTORY">ERR_NOT_DIRECTORY</a></li><li><a href="global.html#ERR_NOT_FILE">ERR_NOT_FILE</a></li><li><a href="global.html#ERR_NOT_FOUND">ERR_NOT_FOUND</a></li><li><a href="global.html#ERR_OUT_OF_SPACE">ERR_OUT_OF_SPACE</a></li><li><a href="global.html#ERR_UNKNOWN">ERR_UNKNOWN</a></li><li><a href="global.html#ERR_UNSUPPORTED_ENCODING">ERR_UNSUPPORTED_ENCODING</a></li><li><a href="global.html#EvalScript_ErrMessage">EvalScript_ErrMessage</a></li><li><a href="global.html#GetValueByKey">GetValueByKey</a></li><li><a href="global.html#NO_ERROR">NO_ERROR</a></li><li><a href="global.html#requiredParamsValid">requiredParamsValid</a></li><li><a href="global.html#strStartsWith">strStartsWith</a></li><li><a href="global.html#UTF8">UTF8</a></li><li><a href="global.html#VulcanInterface">VulcanInterface</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Class: readFile</h1>
<section>
<header>
<h2>
readFile
</h2>
<div class="class-description"><p>readFile<br>Reads the entire contents of a file.</p></div>
</header>
<article>
<div class="container-overview">
<hr>
<dt>
<h4 class="name" id="readFile"><span class="type-signature"></span>new readFile(path, encoding)</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The path of the file to read.</p></td>
</tr>
<tr>
<td class="name"><code>encoding</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The encoding of the contents of file, one of<br> UTF8 (the default) or Base64.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="CEPEngine_extensions.js.html">CEPEngine_extensions.js</a>,
<a href="CEPEngine_extensions.js.html#sunlight-1-line-441">line 441</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object with these properties:<br> <ul><li>"data": The file contents. </li><br> <li>"err": The status of the operation, one of<br> <br>NO_ERROR<br> <br>ERR_UNKNOWN<br> <br>ERR_INVALID_PARAMS<br> <br>ERR_NOT_FOUND<br> <br>ERR_CANT_READ<br> <br>ERR_UNSUPPORTED_ENCODING </li><br> </ul></p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
</div>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
DocStrap Copyright © 2012-2018 The contributors to the JSDoc3 and DocStrap projects.
CEP Resources © 2013 Adobe Systems Incorporated.
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Wed Jan 24th 2018
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>