OutFile Class Reference
[Test - Command line program incorporating Y-Modem source]

Inheritance diagram for OutFile:

[legend]

List of all members.

Public Member Functions
int	Open (const char *fileName, size_t size)
void	Close ()
int	Out (const uint8_t *data, size_t size)

---

Detailed Description

Class for presenting a file as a output stream.

Definition at line 474 of file ymodem_main.cpp.

---

Member Function Documentation

int OutFile::Open	(	const char *	fileName,
		size_t	size
	)			[virtual]

Open stream for writing to a file.

If no data has yet been written to the stream, this function may be called a second time in order to update the file size.

Parameters:

	fileName	Name of the file to write.
	size	Size of data being written to a file.

Returns:

Zero if successful, or a negative error value if failed.

Implements YModemRx::OutStream.

Definition at line 493 of file ymodem_main.cpp.

void OutFile::Close

(

)

Close the stream.

Definition at line 515 of file ymodem_main.cpp.

int OutFile::Out	(	const uint8_t *	data,
		size_t	size
	)			[virtual]

Write data to the stream.

Parameters:

	data	Pointer to data to write.
	size	Size of data.

Returns:

Zero if successful, or a negative error value if failed.

Implements YModemRx::OutStream.

Definition at line 532 of file ymodem_main.cpp.

---

The documentation for this class was generated from the following file:

• comms/test/ymodem_main.cpp