Difference between revisions of "Serial Close"
From WikiPrizm
Jump to navigationJump to search| Line 3: | Line 3: | ||
| index = 0x1BB8 | | index = 0x1BB8 | ||
| header = fxcg/serial.h | | header = fxcg/serial.h | ||
| − | | signature = int Serial_Close(int mode) | + | | signature = int Serial_Close(int mode) |
| synopsis = Closes the serial port, clearing all buffers and optionally aborting any active transmissions. | | synopsis = Closes the serial port, clearing all buffers and optionally aborting any active transmissions. | ||
| parameters = | | parameters = | ||
* '''mode''': Set to 1 to abort any active transmissions, anything else to fail if any transmission is pending. | * '''mode''': Set to 1 to abort any active transmissions, anything else to fail if any transmission is pending. | ||
| − | | returns = 0 on success, or 5 if the port was not closed because a transmission is pending. 5 will only be returned if '''mode''' | + | | returns = 0 on success, or 5 if the port was not closed because a transmission is pending. 5 will only be returned if '''mode''' is not passed as 1. |
}} | }} | ||
[[Category:Syscalls:Serial]] | [[Category:Syscalls:Serial]] | ||
Latest revision as of 06:23, 1 August 2014
Synopsis
Header: fxcg/serial.h
Syscall index: 0x1BB8
Function signature: int Serial_Close(int mode)
Closes the serial port, clearing all buffers and optionally aborting any active transmissions.
Parameters
- mode: Set to 1 to abort any active transmissions, anything else to fail if any transmission is pending.
Returns
0 on success, or 5 if the port was not closed because a transmission is pending. 5 will only be returned if mode is not passed as 1.
