.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxURL 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxURL \- 
  Represents a Universal Resource Locator
 
.SH DESCRIPTION

  


   Parses URLs.
  
  


   Supports standard assignment operators, copy constructors, and comparison
   operators.
  
 
.SH "PARENTS"

  wxURI
 
.SH "INCLUDE FILES"
wx/url.h
.SH MEMBERS

  
.SS  wxURL (const wxString& url)

     


      Constructs a URL object from the string. The URL must be valid according
      to RFC 1738. In particular, file URLs must be of the format
      'file://hostname/path/to/file'. It is valid to leave out the hostname but
      slashes must remain in place-- i.e. a file URL without a hostname must
      contain three consecutive slashes.
     
    
   
  
.SS  ~wxURL ()

     


      Destroys the URL object.
     
    
   
  
.SS wxProtocol& GetProtocol ()

     


      Returns a reference to the protocol which will be used to get the URL.
     
    
   
  
.SS wxURLError GetError ()

     


      Returns the last error. This error refers to the URL parsing or to the
      protocol. It can be one of these errors:
     
     
      
       
        
         wxURL_NOERR
        
       
       
        No error.
       
      

       
      
       
        
         wxURL_SNTXERR
        
       
       
        Syntax error in the URL string.
       
      

       
      
       
        
         wxURL_NOPROTO
        
       
       
        Found no protocol which can get this URL.
       
      

       
      
       
        
         wxURL_NOHOST
        
       
       
        An host name is required for this protocol.
       
      

       
      
       
        
         wxURL_NOPATH
        
       
       
        A path is required for this protocol.
       
      

       
      
       
        
         wxURL_CONNERR
        
       
       
        Connection error.
       
      

       
      
       
        
         wxURL_PROTOERR
        
       
       
        An error occurred during negotiation.
       
      

     
    
   
  
.SS wxInputStream * GetInputStream ()

     


      Creates a new input stream on the specified URL. You can use all but seek
      functionality of wxStream. Seek isn't available on all stream. For
      example, http or ftp streams doesn't deal with it.
     
     


      Note that this method is somewhat depreciated, all future wxWidgets
      applications should really use
      wxFileSystem
      instead.
     
     


      Example:
     
     
  wxURL url("http://a.host/a.dir/a.file");
  if (url.GetError() == wxURL_NOERR)
  {
      wxInputStream *in_stream;

      in_stream = url.GetInputStream();
      // Then, you can use all IO calls of in_stream (See wxStream)
  }

    
   
  
.SS static void SetDefaultProxy (const wxString& url_proxy)

     


      Sets the default proxy server to use to get the URL. The string specifies
      the proxy like this: <hostname>:<port number>.
     
    
   
  
.SS void SetProxy (const wxString& url_proxy)

     


      Sets the proxy to use for this URL.
     
    
 
.SH "SEE ALSO"

  wxURI
 
  wxSocketBase
  wxProtocol
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.