vbSockets Winsock OCX for Visual Basic
Version 0.20 Beta 1
--------------------------------------
(for Versions 4.0a and greater)

DISCLAIMER:
==========================================================================
This control is a beta version.  The creator of this software
is not responsible for any damage caused by the use of this
product.  This software is the sole property of the creator, and
is not sanctioned by ClientLink, Inc.
==========================================================================

This control uses the Windows Sockets 2 API in WINSCK32.DLL.  It is 
designed for use with the Visual Basic programming language (32-bit 
only.)

Since this is a beta version, it may have a few bugs.

==========================================================================
PROPERTIES
==========================================================================

Property Name      Type        Description 
------------------ ----------- ------------------------------------------
WinsockLoaded      Boolean     This is set to true if WSAStartUp()
                               completed successfully.  
Connected          Boolean     This property is set to true if a success-
                               ful connection is made.  (Check this value
                               after calling the Connect() event.)
LocalHostName      String      This is the domain name of the local machine.
                               This property is set during the Connect() 
                               routine.
LocalHostIP        String      This is the IP address of the local machine.
                               This property is set during the Connect()
                               routine.
RemoteHostName     String      This is the domain name of the remote machine.
                               This property may be specified by the user before
                               calling the Connect() method, or, if the 
                               RemoteHostIP property is specified, this property
                               is set during the Connect() method.
RemoteHostIP       String      This is the IP address of the remote machine.
                               This property may be specified by the user before
                               calling the Connect() method, or, if the 
                               RemoteHostName property is specified, this property
                               is set during the Connect() method.
RemotePort         Integer     This is the service port to connect to on the
                               remote machine.  This must be specified before
                               calling the Connect() method.
WSData             clsWSAData  This is a class version of the Winsock WSAData 
                               UDT.  It contains four properties: MaxSockets (Long),
                               MaxUDP (Long), Status (String), and Description(String)
DataBuffer         Collection  Not currently used.
Errors             Collection  A list of Winsock errors is contained here during
                               each session; the objects in this collection are
                               of type clsError which contains four properties: 
                               Code (Long), IsProgram (Boolean), IsWinsock 
                               (Boolean), Description (String).  Code returns the
                               error code.  The IsProgram flag indicates whether or
                               not the error was generated by the control.  The 
                               IsWinsock flag indicates whether or not the error
                               was Winsock generated. (Some errors may have both
                               flags set to true.)  Description returns a text-
                               title for the error (this may not always be set).


==========================================================================
METHODS
==========================================================================
                         Return
Method Name               Type  Description 
------------------        ----  -----------------------------------------------
Connect (void)            void  After setting the RemoteHostIP or RemoteHostName
                                and RemotePort properties, this method is invoked
                                to connect to a remote machine.  During this procedure,
                                WSAStartUp() is called, and the local and remote
                                host names are resolved to addresses and/or vice-
                                versa if required.  If the connect is successful,
                                the Connected property is set to true, else the
                                Connnected property is set to false and WSACleanUp()
                                is called.
Disconnect (void)         void  This method terminates all connections, recycles 
                                the socket, calls WSACleanUp() and sets all objects
                                to null, effectively resetting the control.
SendData (sMsg as String) void  This sends a string of data to the remote host with
                                a trailing CRLF.  (Next versions will have an optional
                                flag to turn off the CRLF.)

==========================================================================
EVENTS
==========================================================================
Event                             Occurs when
--------------------------------- -------------------------------------
InitProperties()                  Control is loaded.        
DataRecieved(sText As String)     Any data is recieved.  (Data is stored in 
                                  sText).
OnConnect()                       Successful connection is established.
OnDisconnect()                    Successful disconnection.
OnDataSend()                      After data is sent.
OnError(lErrorCode As Long)       After error occurs and error object is stored
                                  in the Errors collection.



----------------
Please send all questions, suggestions, answers, and flames to:
         samj@clientlink.com
