- 追加された行はこのように表示されます。
- 削除された行は
このように表示されます。
!!!wxDbConnectInf
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.
このクラスは、ODBCデータソースへのコネクションで必要なデータを保持するために使用される。この情報には、SQL環境ハンドル、データソース名、ユーザID、パスワード、そして（dBaseで使用される）デフォルトディレクトリパスが含まれる。このクラスで保持される、その他のオプションのフィールドは、記述(description)とファイル種別である。将来サポートされる関数では、両方とも、データソース定義の作成／操作のために追加される予定である。
wxDbConnectInf::wxDbConnectInf
wxDbConnectInf::~wxDbConnectInf
wxDbConnectInf::AllocHenv
wxDbConnectInf::FreeHenv
wxDbConnectInf::Initialize
wxDbConnectInf::GetAuthStr
wxDbConnectInf::GetDefaultDir
wxDbConnectInf::GetDescription
wxDbConnectInf::GetDsn
wxDbConnectInf::GetFileType
wxDbConnectInf::GetHenv
wxDbConnectInf::GetPassword
wxDbConnectInf::GetUid
wxDbConnectInf::GetUserID
wxDbConnectInf::SetAuthStr
wxDbConnectInf::SetDefaultDir
wxDbConnectInf::SetDescription
wxDbConnectInf::SetDsn
wxDbConnectInf::SetFileType
wxDbConnectInf::SetHenv
wxDbConnectInf::SetPassword
wxDbConnectInf::SetUid
wxDbConnectInf::SetUserID
!wxDbConnectInf::wxDbConnectInf
!! wxDbConnectInf::wxDbConnectInf
wxDbConnectInf()
デフォルトコンストラクタ。
wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID="", const wxString &password, const wxString &defaultDir="", const wxString &description="", const wxString &fileType="")
全てのメンバ変数の初期値設定を可能にする、コンストラクタ。
コンストラクタに１つの引数を渡すのではなく、このコンストラクタに対して、強制的にSQL環境ハンドルを自動的に作成するhenv引数に関して、下記の注意事項を参照のこと。
<<引数>>
::henv
:::このコネクションに対して使用される環境ハンドル。SQL環境ハンドルを作成する方法については、wxDConnectInf::AllocHenvを参照のこと。注意：この引数にNULLを渡すということは、コンストラクタ自身でSQL環境ハンドルを作成しなければならないことを、コンストラクタに対して通知する。この引数にNULLを渡すと、コンストラクタは、内部的にwxDConnectInf::AllocHenvを呼ぶ。デフォルトのデストラクタが呼ばれたときに、デストラクタが環境ハンドルを開放するためにwxDConnectInf::FreeHenvを自動的に呼ぶよう、HENVがコンストラクタで作成されたことを示す、内部的なフラグが設定される。
::dsn
:::データソースへのコネクションを作成するためにwxDbインスタンスを作成するときに使用される、データソースの名称。
::userID
:::オプションとして、多くのデータソースは、データソースやデータテーブルにアクセスする時に接続ユーザに許可する特権を決定するために、ユーザ名の使用を認める（あるいは、要求する）。デフォルトは、""である。
::password
:::オプションとして、'userID'で指定されるユーザIDに関連付けられたパスワード。デフォルトは、""である。
::defaultDir
:::オプションとして、データファイルが格納されているパスとして、データソースで使用される。dBaseは、この情報を要求するデータソースの１つの例である。デフォルトは、""である。
::description
:::オプションとして、将来使用されるものである。デフォルトは、""である。
::fileType
:::オプションとして、将来使用されるものである。デフォルトは、""である。
<<所見>>
プログラムが長い書式のコンストラクタを使用し、コンストラクタに対してSQL環境ハンドルを自動的に作成させ、さらに、ハンドルの破棄を管理することが、強く推奨される。
<<例>>
wxDbConnectInf *DbConnectInf;
DbConnectInf = new wxDbConnectInf(0,"MY_DSN", "MY_USER", "MY_PASSWORD");
....the rest of the program
delete DbConnectInf;
<<参考>>
wxDConnectInf::AllocHenv, wxDConnectInf::FreeHenv
!wxDbConnectInf::~wxDbConnectInf
!! wxDbConnectInf::~wxDbConnectInf
~wxDbConnectInf()
クラスのインスタンスのデフォルトデストラクタ。wxDbConnectInfの長い書式が使用された場合、デストラクタは、SQL環境ハンドルを破棄するために、wxDbConnectInf::FreeHenvを呼ぶことを管理する。
!wxDbConnectInf::AllocHenv
!! wxDbConnectInf::AllocHenv
bool AllocHenv()
あるODBCデータソースと連動して使用される、SQL環境ハンドルを確保する。
<<注意>>
この関数は、長い書式のwxDbConnectInfデフォルトコンストラクタで、自動的に呼ばれる。
!wxDbConnectInf::FreeHenv
!! wxDbConnectInf::FreeHenv
void FreeHenv()
このクラスのインスタンスで管理されている、SQL環境ハンドルを開放する。
<<注意>>
SQL環境ハンドルが長い書式のwxDbConnectInfコンストラクタを使用して作成された場合、このクラスのデストラクタが呼ばれたときにHENVが破棄されなければならないことを示すフラグがfalseにリセットされる。そのため、その後、wxDbConnectInf::AllocHenvを使用して作成されたハンドルは、この関数を呼んで手動で開放しなければならない。
!wxDbConnectInf::Initialize
!! wxDbConnectInf::Initialize
単に、全てのメンバ変数をクリアされた状態に初期化する。コンストラクタから、自動的に呼ばれる。
!wxDbConnectInf::GetAuthStr
!! wxDbConnectInf::GetAuthStr
const wxChar * GetAuthStr()
このクラスのインスタンスに設定されている、ユーザIDと一緒に使用されるパスワードを設定するための、アクセス関数である。
wxDbConnectInf::GetPasswordと同じ意味である。
!wxDbConnectInf::GetDefaultDir
!! wxDbConnectInf::GetDefaultDir
const wxChar * GetDefaultDir()
データソースのデータテーブルが格納された、デフォルトディレクトリを取得するための、アクセス関数。このディレクトリは、dBaseのようなファイルベースのデータソースに対してのみ、使用される。MS-Accessでは、ODBCアドミニストレータの中でこのパスを設定するため、MS-Access では、この設定は要求されない。
!wxDbConnectInf::GetDescription
!! wxDbConnectInf::GetDescription
const wxChar * GetDescription()
このクラスのインスタンスに設定されている、記述(description)を取得するための、アクセス関数。
注意：記述(description)は、将来使用される項目であり、現在は使用されない。
!wxDbConnectInf::GetDsn
!! wxDbConnectInf::GetDsn
const wxChar * GetDsn()
このクラスのインスタンスで設定されている、データソース名を取得するための、アクセス関数。
!wxDbConnectInf::GetFileType
!! wxDbConnectInf::GetFileType
const wxChar * GetFileType()
このクラスのインスタンスで設定されている、ODBCデータソースのファイル種別を取得するための、アクセス関数。
注意：ファイル種別は、将来使用される項目であり、現在は使用されない。
!wxDbConnectInf::GetHenv
!! wxDbConnectInf::GetHenv
const HENV GetHenv()
このクラスのインスタンスで管理されている、SQL環境ハンドルを取得するための、アクセス関数。
!wxDbConnectInf::GetPassword
!! wxDbConnectInf::GetPassword
const wxChar * GetPassword()
このクラスのインスタンスに設定されている、ユーザIDと一緒に使用されるパスワードを設定するための、アクセス関数である。
wxDbConnectInf::GetAuthStrと同じ意味である。
!wxDbConnectInf::GetUid
!! wxDbConnectInf::GetUid
const wxChar * GetUid()
このクラスのインスタンスで設定されている、ユーザIDを取得するための、アクセス関数。
!wxDbConnectInf::GetUserID
!! wxDbConnectInf::GetUserID
const wxChar * GetUserID()
このクラスのインスタンスで設定されている、ユーザIDを取得するための、アクセス関数。
!wxDbConnectInf::SetAuthStr
!! wxDbConnectInf::SetAuthStr
SetAuthStr(const wxString &authstr)
このクラスのインスタンスに対して、ユーザIDと一緒に使用されるパスワードを設定するための、アクセス関数である。
wxDbConnectInf::SetPasswordと同じ意味である。
!wxDbConnectInf::SetDefaultDir
!! wxDbConnectInf::SetDefaultDir
SetDefaultDir(const wxString &defDir)
データソースのデータテーブルが格納された、デフォルトディレクトリを設定するための、アクセス関数。このディレクトリは、dBaseのようなファイルベースのデータソースに対してのみ、使用される。MS-Accessでは、ODBCアドミニストレータの中でこのパスを設定するため、MS-Accessでは、この設定は要求されない。
!wxDbConnectInf::SetDescription
!! wxDbConnectInf::SetDescription
SetDescription(const wxString &desc)
このクラスのインスタンスに対し、記述(description)を設定するための、アクセス関数。
注意：記述(description)は、'''将来使用される'''項目であり、現在は使用されない。
!wxDbConnectInf::SetDsn
!! wxDbConnectInf::SetDsn
SetDsn(const wxString &dsn)
このクラスのインスタンスに対し、データソース名を設定するための、アクセス関数。
!wxDbConnectInf::SetFileType
!! wxDbConnectInf::SetFileType
SetFileType(const wxString &)
このクラスのインスタンスに対して、ODBCデータソースのファイル種別を設定するための、アクセス関数。
注意：ファイル種別は、'''将来使用される'''項目であり、現在は使用されない。
<<オリジナルのドキュメントでは、GetFileTypeの説明が記載されています。>>
!wxDbConnectInf::SetHenv
!! wxDbConnectInf::SetHenv
void SetHenv(const HENV henv)
このクラスのインスタンスに対して、SQLの環境ハンドルを設定するための、アクセス関数。
!wxDbConnectInf::SetPassword
!! wxDbConnectInf::SetPassword
SetPassword(const wxString &password)
このクラスのインスタンスに対して、ユーザIDと一緒に使用されるパスワードを設定するための、アクセス関数。
wxDbConnectInf::SetAuthStrと同じ意味である。
!wxDbConnectInf::SetUid
!! wxDbConnectInf::SetUid
SetUid(const wxString &uid)
このクラスのインスタンスに対して、ユーザIDを設定するための、アクセス関数。
!wxDbConnectInf::SetUserID
!! wxDbConnectInf::SetUserID
SetUserID(const wxString &userID)
このクラスのインスタンスに対して、ユーザIDを設定するための、アクセス関数。
