Difference between revisions of "Http.get"

From ComputerCraft Wiki
Jump to: navigation, search
(Moved to CAT:LuaCoreFunctions)
(Type-templatify, link to handles documentation in API page, deduplicate description, tidy URL in example)
Line 2: Line 2:
 
{{Function
 
{{Function
 
|name=http.get
 
|name=http.get
|args=[[string]] url
+
|args={{type|string}} url
 
|api=HTTP
 
|api=HTTP
|returns=The response of the server on success or nil on failure.
+
|returns={{type|table}} a [[HTTP (API)#Handles|handle]] on success, or [[nil]] on failure
 
|addon=ComputerCraft
 
|addon=ComputerCraft
|desc=Returns a table similar to that returned by an fs.open() call, used to handle the response of the server on success or nil on failure.
+
|desc=Sends a HTTP GET request to a website, synchronously. Returns when the request completes, successfully or not.
 
|examples=
 
|examples=
 
{{Example
 
{{Example
 
|desc=Gets the content of example.com (in HTML)
 
|desc=Gets the content of example.com (in HTML)
 
|code=local sExample = http.get("http://example.com/") --Get contents of page<br />write(sExample.readAll()) --Read and print contents of page<br />sExample.close() --Just in case
 
|code=local sExample = http.get("http://example.com/") --Get contents of page<br />write(sExample.readAll()) --Read and print contents of page<br />sExample.close() --Just in case
|output=The source of example.com
+
|output=The source of http://example.com/
 
}}
 
}}
 
}}
 
}}
  
 
[[Category:Lua_Core_Functions]]
 
[[Category:Lua_Core_Functions]]

Revision as of 23:14, 5 May 2013


Grid Redstone.png  Function http.get
Sends a HTTP GET request to a website, synchronously. Returns when the request completes, successfully or not.
Syntax http.get(string url)
Returns table a handle on success, or nil on failure
Part of ComputerCraft
API HTTP

Examples

Grid paper.png  Example
Gets the content of example.com (in HTML)
Code
local sExample = http.get("http://example.com/") --Get contents of page
write(sExample.readAll()) --Read and print contents of page
sExample.close() --Just in case
Output The source of http://example.com/