File Transfer Services - Revision history

Marku at 15:41, 6 July 2015

2015-07-06T15:41:43Z

← Older revision		Revision as of 15:41, 6 July 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	Stride provides an API for performing file operations on the host from test code executing on the device. In order for the file APIs to be operational, your test code must be executed in the context of the [[STRIDE Runner]]. The host filesystem operations provided by this APIs encompass the following functionality:		Stride provides an API for performing file operations on the host from test code executing on the device. In order for the file APIs to be operational, your test code must be executed in the context of the [[STRIDE Runner \| Stride Runner]]. The host filesystem operations provided by this APIs encompass the following functionality:
	* open/close		* open/close
	* read/write		* read/write

Marku at 16:10, 1 July 2015

2015-07-01T16:10:55Z

← Older revision		Revision as of 16:10, 1 July 2015
Line 1:		Line 1:
	~~== Introduction ==~~		__NOTOC__
			Stride provides an API for performing file operations on the host from test code executing on the device. In order for the file APIs to be operational, your test code must be executed in the context of the [[STRIDE Runner]]. The host filesystem operations provided by this APIs encompass the following functionality:
	~~The STRIDE Framework~~ provides an API for performing file operations on the host from test code executing on the device. In order for the file APIs to be operational, your test code must be executed in the context of the [[STRIDE Runner]]. The host filesystem operations provided by this APIs encompass the following functionality:
	* open/close		* open/close
	* read/write		* read/write
Line 9:		Line 8:
	* error messaging related to any failures in these operations		* error messaging related to any failures in these operations

	~~== Examples ==~~		'''Example'''

	~~=== read entire contents of a host file ===~~

	The following code sample shows how to read the entire contents of a file on the host. The code currently just discards the buffer contents with each read operation, but actual code would likely store or process the file contents.		The following code sample shows how to read the entire contents of a file on the host. The code currently just discards the buffer contents with each read operation, but actual code would likely store or process the file contents.
Line 41:		Line 38:
	}		}

	~~srNOTE2_INFO~~("read %lu bytes from %s", totalBytesRead , file);		srNOTE_INFO("read %lu bytes from %s", totalBytesRead , file);

	QUIT:		QUIT:
Line 55:		Line 52:
	</source>		</source>

	~~== Reference ==~~

	~~The following sections document the srFile API.~~		== srFileOpen ==

	=== srFileOpen ===

	srFileOpen() opens a file on the host computer.		srFileOpen() opens a file on the host computer.
Line 98:		Line 92:
	\|}		\|}

	=== srFileClose ===
			== srFileClose ==

	srFileClose () closes a remote file associated with the specified handle.		srFileClose () closes a remote file associated with the specified handle.
Line 125:		Line 120:


	=== srFileSeek ===		== srFileSeek ==

	srFileSeek() seeks to the specified position within an open remote file stream by moving ''lOffset'' bytes relative to a position specified by ''eOrigin''.		srFileSeek() seeks to the specified position within an open remote file stream by moving ''lOffset'' bytes relative to a position specified by ''eOrigin''.
Line 165:		Line 160:


	=== srFileTell ===		== srFileTell ==

	srFileTell() returns the current position of <i>hFile</i> relative to the beginning of the file.		srFileTell() returns the current position of <i>hFile</i> relative to the beginning of the file.
Line 197:		Line 192:


	=== srFileRead ===		== srFileRead ==

	srFileRead() reads ''dwBytesToRead'' bytes from an open remote file stream and stores the data in the memory pointed to by ''pvData''. The current position of the stream is advanced by the number of bytes read.		srFileRead() reads ''dwBytesToRead'' bytes from an open remote file stream and stores the data in the memory pointed to by ''pvData''. The current position of the stream is advanced by the number of bytes read.
Line 240:		Line 235:


	=== srFileWrite ===		== srFileWrite ==

	srFileWrite() writes ''dwBytesToWrite'' bytes from the memory location specified in ''pvData'' to an open remote file stream. The current position of the stream is advanced by the number of bytes written.		srFileWrite() writes ''dwBytesToWrite'' bytes from the memory location specified in ''pvData'' to an open remote file stream. The current position of the stream is advanced by the number of bytes written.
Line 283:		Line 278:


	=== srFileGets ===		== srFileGets ==

	srFileGets () gets a string from an open remote file stream and stores the data in the memory pointed to by ''szBuff''. Reads characters from the current stream position to and including the first newline character, to the end of the stream, or until the number of characters read is equal to ''dwSize – 1'', whichever comes first.		srFileGets () gets a string from an open remote file stream and stores the data in the memory pointed to by ''szBuff''. Reads characters from the current stream position to and including the first newline character, to the end of the stream, or until the number of characters read is equal to ''dwSize – 1'', whichever comes first.
Line 320:		Line 315:


	=== srFilePuts ===		== srFilePuts ==

	srFilePuts() puts a null-terminated string specified in ''szBuff'' to an open remote file stream. The current position of the stream is advanced by the number of bytes written.		srFilePuts() puts a null-terminated string specified in ''szBuff'' to an open remote file stream. The current position of the stream is advanced by the number of bytes written.
Line 352:		Line 347:


	=== srFileEOF ===		== srFileEOF ==

	srFileEOF() checks whether the remote file's end of file flag is set.		srFileEOF() checks whether the remote file's end of file flag is set.
Line 379:		Line 374:


	=== srFileError ===		== srFileError ==

	srFileError() checks whether the remote file error flag has been set by a preceeding operation.		srFileError() checks whether the remote file error flag has been set by a preceeding operation.
Line 406:		Line 401:


	=== srFileClearErr ===		== srFileClearErr ==

	srFileClearErr() clears the error flag for the remote file		srFileClearErr() clears the error flag for the remote file
Line 427:		Line 422:


	=== srFileGetErrorMessage ===		== srFileGetErrorMessage ==

	srFileGetErrorMessage() gets the last error message for the remote file, if any.		srFileGetErrorMessage() gets the last error message for the remote file, if any.
Line 464:		Line 459:


	=== srFileGetTempName ===		== srFileGetTempName ==

	srFileGetTempName() gets an unique name for a temporary file on the host.		srFileGetTempName() gets an unique name for a temporary file on the host.
Line 495:		Line 490:
	\|}		\|}

	=== srFileRemove ===
			== srFileRemove ==

	srFileRemove() removes a file on the host.		srFileRemove() removes a file on the host.
Line 521:		Line 517:
	\|}		\|}

	=== srFileRename===
			== srFileRename==

	srFileRename() moves/renames a file on the host.		srFileRename() moves/renames a file on the host.
Line 553:		Line 550:
	\|}		\|}

	=== srPrompt===
			== srPrompt==

	srPrompt() provides interactive console prompt on the host.		srPrompt() provides interactive console prompt on the host.
Line 593:		Line 591:
	\| 0 on success, error code otherwise.		\| 0 on success, error code otherwise.
	\|}		\|}


	== Notes ==		== Notes ==
	<references/>		<references/>

	~~[[Category: Test Units]]~~

Ivailop: /* srFileRename */

2014-08-05T19:50:55Z

srFileRename

@@ Line 543: / Line 543: @@
 | Full path to the new remote file (located on the host computer).<ref name="env"/>
 |}
 <br>

Ivailop: /* srFileGetTempName */

2014-08-05T19:47:25Z

srFileGetTempName

← Older revision		Revision as of 19:47, 5 August 2014
Line 480:		Line 480:
	\| szHostPath		\| szHostPath
	\| Output		\| Output
	\| Pointer to a character buffer to populate with the file path name.		\| Pointer to a character buffer to populate with the file path name.).<ref name="env"/>
	\|-		\|-
	\| dwSize		\| dwSize

Timd at 21:50, 21 June 2011

2011-06-21T21:50:27Z

← Older revision		Revision as of 21:50, 21 June 2011
Line 41:		Line 41:
	}		}

	~~srLOG2_INFO~~("read %lu bytes from %s", totalBytesRead , file);		srNOTE2_INFO("read %lu bytes from %s", totalBytesRead , file);

	QUIT:		QUIT:
Line 48:		Line 48:
	srCHAR errorBuffer[srFILE_MAX_ERROR_LENGTH] = {0};		srCHAR errorBuffer[srFILE_MAX_ERROR_LENGTH] = {0};
	srFileGetErrorMessage(result, errorBuffer, srFILE_MAX_ERROR_LENGTH);		srFileGetErrorMessage(result, errorBuffer, srFILE_MAX_ERROR_LENGTH);
	~~srLOG_ERROR~~(errorBuffer);		srNOTE_ERROR(errorBuffer);
	}		}

Ivailop: /* Examples */

2011-06-09T20:13:38Z

Examples

← Older revision		Revision as of 20:13, 9 June 2011
Line 17:		Line 17:
	<source lang="c">		<source lang="c">
	srCHAR file[] = "/path/to/host/file";		srCHAR file[] = "/path/to/host/file";
	srBYTE readBuffer[~~srFILE_DATA_CHUNK_SIZE~~] = {0};		srBYTE readBuffer[1024] = {0};
	srFileHandle_t handle = 0;		srFileHandle_t handle = 0;
	srDWORD result = 0;		srDWORD result = 0;
Line 29:		Line 29:
	{		{
	srDWORD actualBytesRead = 0;		srDWORD actualBytesRead = 0;
	if (0 != (result = srFileRead(handle, readBuffer, ~~srFILE_DATA_CHUNK_SIZE~~, &actualBytesRead)))		if (0 != (result = srFileRead(handle, readBuffer, sizeof(readBuffer), &actualBytesRead)))
	goto QUIT;		goto QUIT;

Ivailop: /* srFileOpen */

2011-03-22T17:03:17Z

srFileOpen

← Older revision		Revision as of 17:03, 22 March 2011
Line 61:		Line 61:
	=== srFileOpen ===		=== srFileOpen ===

	srFileOpen() opens a file on the host computer. ~~Creates the file if it does not exist.~~		srFileOpen() opens a file on the host computer.

	<source lang="c">		<source lang="c">
	srDWORD srFileOpen(const srCHAR * szHostPath,		srDWORD srFileOpen(const srCHAR * szHostPath,
Line 81:		Line 80:
	\| Input		\| Input
	\| Mode string for opening the file - can be one of the following:		\| Mode string for opening the file - can be one of the following:
	* r		* <b>r</b> - open for reading
	* w		* <b>w</b> - open for writing (creates file if it doesn't exist). Deletes content and overwrites the file.
	* a		* <b>a</b> - open for appending (creates file if it doesn't exist)
	A '+' sign can be added to any of these mode characters to request simultaneous read/write access. Files are always opened in binary mode, so no text character translation is done.		A '+' sign can be added to any of these mode characters to request simultaneous read/write access. Files are always opened in binary mode, so no text character translation is done.
	\|-		\|-

Ivailop: /* srFileOpen */

2011-03-22T16:56:42Z

srFileOpen

← Older revision		Revision as of 16:56, 22 March 2011
Line 61:		Line 61:
	=== srFileOpen ===		=== srFileOpen ===

	srFileOpen() opens a file on the host computer.		srFileOpen() opens a file on the host computer. Creates the file if it does not exist.

	<source lang="c">		<source lang="c">

Ivailop: /* srFileGetTempName */

2010-06-09T21:56:02Z

srFileGetTempName

← Older revision		Revision as of 21:56, 9 June 2010
Line 481:		Line 481:
	\| szHostPath		\| szHostPath
	\| Output		\| Output
	\| Pointer to a character buffer to populate with the file path name. ~~<ref name="env"/>~~		\| Pointer to a character buffer to populate with the file path name.
	\|-		\|-
	\| dwSize		\| dwSize

Ivailop: /* srFileOpen */

2010-06-09T21:53:56Z

srFileOpen

← Older revision		Revision as of 21:53, 9 June 2010
Line 76:		Line 76:
	\| szHostPath		\| szHostPath
	\| Input		\| Input
	\| Full path to the remote file (located on the host computer) <ref name="env">~~You~~ could reference host environment variables (e.g. ''$VAR/path/file'') using syntax of your choice - %VAR%, $VAR, $(VAR), ${VAR}</ref>		\| Full path to the remote file (located on the host computer) <ref name="env">A full path to the remote file (located on the host computer) could reference host environment variables (e.g. ''$VAR/path/file'') using syntax of your choice - %VAR%, $VAR, $(VAR), or ${VAR}</ref>
	\|-		\|-
	\| szMode		\| szMode