Documentation/Web: Web documentation by ``Echo_''!

Doc/sphinx/scriptref/web.rst

@@ -11,6 +11,7 @@ OpenWebPage
 
     procedure OpenWebPage(const url : string);
 
+OpenWebPage opens the given web page (url) with your default browser.
 
 GetPage
 ~~~~~~~
@@ -19,6 +20,8 @@ GetPage
 
     function GetPage(const url : string): string;
 
+GetPage returns a string of HTML from the given web page.
+
 
 InitializeHTTPClient
 ~~~~~~~~~~~~~~~~~~~~
@@ -27,6 +30,8 @@ InitializeHTTPClient
 
     function InitializeHTTPClient(HandleCookies: Boolean): Integer;
 
+InitializeHTTPClient creates a new client and assigns it an ID. You use this for
+all the other web functions that require a client.
 
 InitializeHTTPClientWrap
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -35,6 +40,8 @@ InitializeHTTPClientWrap
 
     function InitializeHTTPClientWrap(HandleCookies: Boolean): Integer;
 
+This should probably not be documented.
+
 
 FreeHTTPClient
 ~~~~~~~~~~~~~~
@@ -43,6 +50,7 @@ FreeHTTPClient
 
     procedure FreeHTTPClient(Client: Integer);
 
+Free the HTTP client returned by *InitializeHTTPClient*.
 
 GetHTTPPage
 ~~~~~~~~~~~
@@ -51,6 +59,9 @@ GetHTTPPage
 
     function GetHTTPPage(Client: Integer;const URL: string): string;
 
+GetHTTPPage is just like GetPage, except you can choose which client to get the
+HTTP code from.
+
 
 SetHTTPUserAgent
 ~~~~~~~~~~~~~~~~
@@ -59,6 +70,7 @@ SetHTTPUserAgent
 
     procedure SetHTTPUserAgent(Client: Integer;const Agent: string);
 
+SetHTTPUserAgent allows you to change the agent string of a client.
 
 PostHTTPPage
 ~~~~~~~~~~~~
@@ -67,6 +79,8 @@ PostHTTPPage
 
     function PostHTTPPage(Client: Integer;const Url,PostData: string): string;
 
+PostHTTPPage requests to post data (PostData) on the web page (Url) of the
+client (Client).
 
 PostHTTPPageEx
 ~~~~~~~~~~~~~~
@@ -75,6 +89,8 @@ PostHTTPPageEx
 
     function PostHTTPPageEx(Client: Integer;const Url: string): string;
 
+PostHTTPPageEx is just like PostHTTPPage but uses predefined post data added by
+ddPostVariable and cleared by ClearPostData.
 
 ClearPostData
 ~~~~~~~~~~~~~
@@ -83,6 +99,9 @@ ClearPostData
 
     procedure ClearPostData(Client: Integer);
 
+ClearPostData clears the post data added to the web page (Client). Used with
+PostHTTPPageEx.
+
 
 AddPostVariable
 ~~~~~~~~~~~~~~~
@@ -91,6 +110,8 @@ AddPostVariable
 
     procedure AddPostVariable(Client: Integer;const VarName, VarValue: string);
 
+AddPostVariable adds a post variable to the web page (Client). Used with
+PostHTTPPageEx.
 
 GetRawHeaders
 ~~~~~~~~~~~~~
@@ -99,6 +120,8 @@ GetRawHeaders
 
     function GetRawHeaders(Client: Integer): string;
 
+GetRawHeaders returns a string of headers from the specified client.
+
 
 SetProxy
 ~~~~~~~~
@@ -107,6 +130,8 @@ SetProxy
 
     procedure SetProxy(Client : Integer; pHost, pPort : String);');
 
+SetProxy configures a proxy with the given client (Client) proxy host (pHost)
+and port (pPort).
 
 CreateSocket
 ~~~~~~~~~~~~
@@ -115,6 +140,7 @@ CreateSocket
 
     function CreateSocket: integer;
 
+CreateSocket creates a new socket and assigns it an ID.
 
 FreeSocket
 ~~~~~~~~~~
@@ -123,6 +149,7 @@ FreeSocket
 
     procedure FreeSocket(Index: integer);
 
+FreeSocket frees the socket with the ID (Index) assigned to it upon creation.
 
 ConnectSocket
 ~~~~~~~~~~~~~
@@ -131,6 +158,9 @@ ConnectSocket
 
     procedure ConnectSocket(Client: integer; IP, Port: string);
 
+ConnectSocket connects the socket to an IP and port on the specified client
+(Client).
+
 
 BindSocket
 ~~~~~~~~~~
@@ -139,6 +169,8 @@ BindSocket
 
     procedure BindSocket(Client: integer; IP, Port: string);
 
+BindSocket binds a connected socket to an IP and port on the specified client
+(Client).
 
 ListenSocket
 ~~~~~~~~~~~~
@@ -147,6 +179,8 @@ ListenSocket
 
     procedure ListenSocket(Client: integer);
 
+ListenSocket allows for a client socket to accept connections.
+
 
 AcceptSocket
 ~~~~~~~~~~~~
@@ -155,6 +189,8 @@ AcceptSocket
 
     function AcceptSocket(Client: integer): integer;
 
+AcceptSocket accepts pending connection requests to a client socket.
+
 
 CloseSocket
 ~~~~~~~~~~~
@@ -163,6 +199,8 @@ CloseSocket
 
     procedure CloseSocket(Client: integer);
 
+CloseSocket closes connections to a client socket.
+
 RecvSocket
 ~~~~~~~~~~
 
@@ -170,6 +208,7 @@ RecvSocket
 
     function RecvSocket(Client: integer): string;
 
+RecvSocket method reads all data waiting for read.
 
 RecvSocketStr
 ~~~~~~~~~~~~~
@@ -178,13 +217,18 @@ RecvSocketStr
 
     function RecvSocketStr(Client: integer): string;
 
+Method waits until data string is received. This string is terminated by CR-LF
+characters. The resulting string is returned without this termination (CR-LF)
 
 RecvSocketEx
 ~~~~~~~~~~~~
 
 .. code-block:: pascal
 
-    unction RecvSocketEx(Client, Length: integer): string;
+    function RecvSocketEx(Client, Length: integer): string;
+
+RecvSocketEx returns received data of a specified length from a bound socket as
+a string.
 
 
 SendSocket
@@ -194,6 +238,7 @@ SendSocket
 
     procedure SendSocket(Client: integer; Data: string);
 
+SendSocket sends a string of data to a bound client socket.
 
 SetTimeout
 ~~~~~~~~~~
@@ -202,6 +247,8 @@ SetTimeout
 
     procedure SetTimeout(Client, Time: integer);
 
+SetTimeout sets a maximum amount of time for a bound client socket to wait for
+data from another socket.
 
 SocketInfo
 ~~~~~~~~~~
@@ -210,4 +257,4 @@ SocketInfo
 
     procedure SocketInfo(Client: integer; out IP, Port: string);
 
-
+SocketInfo sets where a bound socket will be sending data to (out IP, out Port).