ReadFile - Revision history

Ghenne at 14:18, 13 November 2020

2020-11-13T14:18:48Z

← Older revision		Revision as of 14:18, 13 November 2020
Line 18:		Line 18:
	It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.		It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.

	There is no equivalent WriteFile. Use [[Sql]], [[LocalStorage]] or ~~the~~ [[~~Using_the_PhoneGap_API~~\|~~PhoneGap API~~]] to save data.		There is no equivalent WriteFile. Use [[Sql]], [[LocalStorage]] or a [[Using_Cordova_Plugins\|Cordova plugin]] to save data.

	'''Returning the latest file contents		'''Returning the latest file contents

Ghenne at 14:37, 26 January 2017

2017-01-26T14:37:20Z

← Older revision		Revision as of 14:37, 26 January 2017
Line 5:		Line 5:
	Note: This function can be replaced by the [[Ajax]]() function.		Note: This function can be replaced by the [[Ajax]]() function.

	ReadFile will read ''filename'' which can either be deployed with the app or be on the same server as the app. If the file is to be deployed with the app, include it in the manifest. This function will only work when deployed to a website: it will not work when ~~running in the~~ local ~~browser~~.		ReadFile will read ''filename'' which can either be deployed with the app or be on the same server as the app. If the file is to be deployed with the app, include it in the manifest. This function will only work when deployed to a website: it will not work when deployed to a local folder.

	Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".		Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".

Ghenne at 13:21, 8 April 2015

2015-04-08T13:21:54Z

← Older revision		Revision as of 13:21, 8 April 2015
Line 11:		Line 11:
	If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server.		If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server.

	If you do not use a callBack ~~argument~~, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:		If you do not use a ''callBack'', you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:
	<pre>		<pre>
	Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects		Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects

Ghenne: /* Description */

2015-04-08T13:20:23Z

Description

← Older revision		Revision as of 13:20, 8 April 2015
Line 9:		Line 9:
	Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".		Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".

	If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:		If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server.

			If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:
	<pre>		<pre>
	Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects		Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects

Ghenne: /* Description */

2015-04-08T12:29:59Z

Description

← Older revision		Revision as of 12:29, 8 April 2015
Line 11:		Line 11:
	If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:		If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:
	<pre>		<pre>
	Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check http://xhr.spec.whatwg.org/.</pre>		Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects
			to the end user's experience. For more help, check http://xhr.spec.whatwg.org/.</pre>

	It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.		It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.

Ghenne: /* Description */

2015-04-08T12:29:24Z

Description

← Older revision		Revision as of 12:29, 8 April 2015
Line 9:		Line 9:
	Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".		Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".

	If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]].		If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]]:
			<pre>
			Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check http://xhr.spec.whatwg.org/.</pre>

	It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.		It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.

Ghenne: /* Description */

2015-04-06T15:11:24Z

Description

← Older revision		Revision as of 15:11, 6 April 2015
Line 7:		Line 7:
	ReadFile will read ''filename'' which can either be deployed with the app or be on the same server as the app. If the file is to be deployed with the app, include it in the manifest. This function will only work when deployed to a website: it will not work when running in the local browser.		ReadFile will read ''filename'' which can either be deployed with the app or be on the same server as the app. If the file is to be deployed with the app, include it in the manifest. This function will only work when deployed to a website: it will not work when running in the local browser.

	Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample.		Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample in Samples folder 7 "Ajax and ReadFile".

	If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]].		If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]].

Ghenne: /* Description */

2015-04-06T15:09:10Z

Description

← Older revision		Revision as of 15:09, 6 April 2015
Line 9:		Line 9:
	Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample.		Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample.

	If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the Chrome Debugger.		If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the [[Using the Chrome Debugger\|Chrome Debugger]].

	It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.		It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.

Ghenne at 15:08, 6 April 2015

2015-04-06T15:08:43Z

← Older revision		Revision as of 15:08, 6 April 2015
Line 1:		Line 1:
	ReadFile (''filename''[,''method''])		ReadFile (''filename''[,''method''[, callBack]])

	== Description ==		== Description ==
Line 8:		Line 8:

	Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample.		Use ''method'' to define the access method. Usually this parameter can be left out: the default is Get. The next most common value for this is Post. Post responses are never cached, whereas Get responses can be. Post also allows larger data transfers. Other methods are Connect, Delete, Head, Options, Put, Trace, or Track. For more information on these options, look up XMLHttpRequest on the web. The function is based on XMLHttpRequest. See the ReadFile.nsx sample.

			If you supply a ''callBack'' argument, a function with that name will be called when the read is complete. Adding this option will cause the operation to become asynchronous. The next statement after ReadFile will be executed immediately, before the read is complete. This results in smoother operation for the user, especially if the file is on a remote server. If you do not use a callBack argument, you will see a warning in the Chrome Debugger.

	It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.		It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.

	There is no ~~equivilent~~ WriteFile. Use [[Sql]], [[LocalStorage]] or the [[Using_the_PhoneGap_API\|PhoneGap API]] to save data.		There is no equivalent WriteFile. Use [[Sql]], [[LocalStorage]] or the [[Using_the_PhoneGap_API\|PhoneGap API]] to save data.

	'''Returning the latest file contents		'''Returning the latest file contents

James: Cleaning up links and inaccuracies.

2014-07-14T19:40:56Z

Cleaning up links and inaccuracies.

← Older revision		Revision as of 19:40, 14 July 2014
Line 11:		Line 11:
	It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.		It returns two values: .status = 0 or 200 if the file was read successfully and .responseText which has the entire contents of the file. If the file is not read successfully, a different status code is returned in .status.

	There is no equivilent WriteFile. Use [[~~sql\|~~Sql]], [[~~localstorage\|~~LocalStorage]] or the PhoneGap API to save data.		There is no equivilent WriteFile. Use [[Sql]], [[LocalStorage]] or the [[Using_the_PhoneGap_API\|PhoneGap API]] to save data.

	'''Returning the latest file contents		'''Returning the latest file contents
Line 20:		Line 20:
	<pre>		<pre>
	Dim usrFile, req		Dim usrFile, req
	usrFile = "users/12345.xml?&" & SysInfo(10)		usrFile = "users/12345.xml?" & SysInfo(10)
	req = ReadFile(usrFile)		req = ReadFile(usrFile)
	</pre>		</pre>

	~~This~~ ?&" & SysInfo(10) at the end of the .xml ensures that the latest file on the server is returned. This is useful where you perhaps update the file and want to return the latest version later on within your application. Excluding this will only return the last cached file contents that you read.		The <code>?" & SysInfo(10)</code> at the end of the .xml ensures that the latest file on the server is returned. This is useful where you perhaps update the file and want to return the latest version later on within your application. Excluding this will only return the last cached file contents that you read.

	== Example ==		== Example ==
Line 41:		Line 41:
	== Related Items ==		== Related Items ==

	[[~~ajax\|~~Ajax]]		* [[Ajax]]

	[[Category:Language Reference]]		[[Category:Language Reference]]

	[[Category:Miscellaneous]]		[[Category:Miscellaneous]]