Differences

This shows you the differences between two versions of the page.

--- uphp:functions:fgets [2017/03/31 13:31]
jeff
+++ uphp:functions:fgets [2021/09/13 05:57] (current)
@@ Line 3: / Line 3: @@
 <badge>WMPRO, WMMINI FW >= 1.0</badge> <badge>WMMEGA FW >= 2.0</badge>
-Return a single line from a file or stream, with optional size limit
+Return a single line from a file, stream or socket, with optional size limit
 ====Description====
-<well size="sm"><html><span style="font-size:125%;color:green">mixed
+<well size="sm"><html>
-<span style="color:black"></html>[[fgets]]
+<span style="font-size:125%;color:green">mixed
-<html>(
+<span style="color:black">fgets (
 <span style="color:green">int
 <span style="color:blue">$handle
@@ Line 18: / Line 18: @@
 </html></well>
-This function works with different resource types. If no size is specified, it will keep reading from the file or stream until it reaches the end of the line (or the end of the file). For sockets and streams it will return characters until a line feed (LF) or carriage return (CR) is reached (it will wait until an entire line is received). If the optional size is specified and the line is longer than this size, the function will return only the number of characters specified.
+This function works with different resource types. If no size is specified, it will keep reading from the file, stream or socket until it reaches the end of the line (or the end of the file). For streams and sockets it will return characters until a line feed (LF) or carriage return (CR) is reached (it will wait until an entire line is received). If the optional size is specified and the line is longer than this size, the function will return only the number of characters specified.
+**Note:** The maximum length of a returned string in [[hardware:wattmons|Wattmon]] is 254 bytes so when reading a longer input stream, you will need to check the string length using [[strlen()]] and if it is equal to 254 you would need to perform additional reads to ensure that a full line is read from the input stream.
 ====Parameters====
-<html><span style="color:blue"><b>$handle</b><span style="color:black"></html>:  Valid handle of a previously opened resource
+<html><b><span style="color:blue">$handle<span style="color:black"></b></html>:  Valid handle of a previously opened resource
-<html><span style="color:blue"><b>$size</b><span style="color:black"></html>:  Optional limit to the number of bytes returned
+<html><b><span style="color:blue">$size<span style="color:black"></b></html>:  Optional limit to the number of bytes returned
 ====Return Values====
-  * <html><span style="color:green"><b>string</b><span style="color:black"></html> containing the line of characters (without CR/LF)
+  * <html><b><span style="color:green">String<span style="color:black"></b></html> containing the line of characters (without CR/LF)
-    * Empty string if there is no data on the line
+    * Empty <html><b><span style="color:green">string<span style="color:black"></b></html> if there is no data on the line
-  * <html><span style="color:green"><b>int</b><span style="color:black"></html> -1 for error
+  * <html><b><span style="color:green">Integer<span style="color:black"></b></html> -1 for error
 ====Example====
-**Open a TCP connection to google.com and print the header for a search for the word 'test':**
+===Open a TCP connection to google.com and print the header for a search for the word 'test'===
 <code php>
@@ Line 58: / Line 60: @@
 </code>
-====See Also====
+====Also See====
-[[fread()]] - Return bytes from a file or stream
+[[strlen()]] - Return the length of a <html><b><span style="color:green">string</b></html>
-[[fwrite()]] - Write data to a file or stream
+[[fopen()]] - Open a file for reading or writing
+[[fseropen()]] - Open the serial port at the specified baud rate with optional parameters
+[[f485open()]] - Open the RS-485 port at the specified baud rate and parity
 [[fsockopen()]] - Open an internet socket connection with optional timeout
-[[fopen()]] - Open a file for reading or writing
+[[fread()]] - Read bytes from a file, stream or socket
-[[f485open()]] - Open the RS-485 port at the specified baud rate and parity
+[[fwrite()]] - Write data to a file, stream or socket
-[[fseropen()]] - Open the serial port at the specified baud rate with optional parameters
+[[feof()]] - Test if no more data is available in a file, stream or socket
+[[filesize()]] - Return the size of a file, or the number of unread bytes in a stream or socket
+[[fseek()]] - Position the file pointer in an open file
+[[ftell()]] - Return the current position of a file read/write pointer
 [[fclose()]] - Close a file, stream or socket

Wattmon Documentation Wiki

User Tools

Site Tools

Differences

Page Tools