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

  


   This class is used for holding the data necessary for connecting to the ODBC
   datasource. That information includes: SQL environment handle, datasource
   name, user ID, password and default directory path (used with dBase). Other
   optional fields held in this class are and file type, both for future
   functions planned to be added for creating/manipulating datasource
   definitions.
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"

.SH MEMBERS

  
.SS  wxDbConnectInf ()

     


      Default constructor.
     
    
.SS  wxDbConnectInf (HENV henvconst wxString &dsnconst wxString &userID = ""const wxString &passwordconst wxString &defaultDir = ""const wxString &description = ""const wxString &fileType = "")

     


      Constructor which allows initial settings of all the classes member
      variables.
     
     


      See the special note below on the henv parameter for forcing this
      constructor to create a SQL environment handle automatically, rather than
      needing to pass one in to the function.
     
    
   
  
.SS  ~wxDbConnectInf ()

     


      Handles the default destruction of the instance of the class. If the long
      form of the
      wxDConnectInf
      was used, then this destructor also takes care of calling
      wxDConnectInf::FreeHenv
      to free the SQL environment handle.
     
    
   
  
.SS bool  AllocHenv ()

     


      Allocates a SQL environment handle that will be used to interface with an
      ODBC datasource.
     
    
   
  
.SS void FreeHenv ()

     


      Frees the SQL environment handle being managed by the instance of this
      class.
     
    
   
  
   
  
.SS const wxChar * GetAuthStr ()

     


      Accessor function to return the password assigned for this class instance
      that will be used with the user ID.
     
     


      Synonymous with
      wxDbConnectInf::GetPassword
     
    
   
  
.SS const wxChar * GetDefaultDir ()

     


      Accessor function to return the default directory in which the
      datasource's data table is stored. This directory is only used for file
      based datasources like dBase. MS-Access does not require this to be set,
      as the path is set in the ODBC Administrator for MS-Access.
     
    
   
  
.SS const wxChar * GetDescription ()

     


      Accessor function to return the description assigned for this class
      instance.
     
     


      NOTE: Description is a FUTURE USE item and is unused currently.
     
    
   
  
.SS const wxChar * GetDsn ()

     


      Accessor function to return the datasource name assigned for this class
      instance.
     
    
   
  
.SS const wxChar * GetFileType ()

     


      Accessor function to return the filetype of the ODBC datasource assigned
      for this class instance.
     
     


      NOTE: FileType is a FUTURE USE item and is unused currently.
     
    
   
  
.SS const HENV GetHenv ()

     


      Accessor function to return the SQL environment handle being managed by
      this class instance.
     
    
   
  
.SS const wxChar * GetPassword ()

     


      Accessor function to return the password assigned for this class instance
      that will be used with the user ID.
     
     


      Synonymous with
      wxDbConnectInf::GetAuthStr
     
    
   
  
.SS const wxChar * GetUid ()

     


      Accessor function to return the user ID assigned for this class instance.
     
    
   
  
.SS const wxChar * GetUserID ()

     


      Accessor function to return the user ID assigned for this class instance.
     
    
   
  
.SS void SetAuthStr ()

     


      Accessor function to assign the password for this class instance that will
      be used with the user ID.
     
     


      Synonymous with
      wxDbConnectInf::SetPassword
     
    
   
  
.SS void SetDefaultDir ()

     


      Accessor function to assign the default directory in which the
      datasource's data table is stored. This directory is only used for file
      based datasources like dBase. MS-Access does not require this to be set,
      as the path is set in the ODBC Administrator for MS-Access.
     
    
   
  
.SS void SetDescription ()

     


      Accessor function to assign the description assigned for this class
      instance.
     
     


      NOTE: Description is a FUTURE USE item and is unused currently.
     
    
   
  
.SS void SetDsn ()

     


      Accessor function to assign the datasource name for this class instance.
     
    
   
  
.SS void SetFileType ()

     


      Accessor function to return the filetype of the ODBC datasource assigned
      for this class instance.
     
     


      NOTE: FileType is a FUTURE USE item and is unused currently.
     
    
   
  
.SS void SetHenv (const HENV henv)

     


      Accessor function to set the SQL environment handle for this class
      instance.
     
    
   
  
.SS void SetPassword ()

     


      Accessor function to assign the password for this class instance that will
      be used with the user ID.
     
     


      Synonymous with
      wxDbConnectInf::SetAuthStr
     
    
   
  
.SS void SetUid ()

     


      Accessor function to set the user ID for this class instance.
     
    
   
  
.SS void SetUserID ()

     


      Accessor function to assign the user ID for this class instance.
     
    
 
.SH "SEE ALSO"

.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.