SQLWriteDSNToIni 関数

準拠
導入されたバージョン: ODBC 1.0

まとめ
SQLWriteDSNToIni は 、データ ソースをシステム情報に追加します。

構文

  
BOOL SQLWriteDSNToIni(  
     LPCSTR   lpszDSN,  
     LPCSTR   lpszDriver);  

引数

lpszDSN
[入力]追加するデータ ソースの名前。

lpszDriver
[入力]物理ドライバー名ではなく、ユーザーに提示されるドライバーの説明 (通常は関連付けられている DBMS の名前)。

戻り値

関数は成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

診断

SQLWriteDSNToIni が FALSE を返す場合は、SQLInstallerError を呼び出すことによって、関連付けられた *pfErrorCode 値を取得できます。 次の表に、SQLInstallerError によって返される *pfErrorCode 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。

*pfErrorCode	エラー	説明
ODBC_ERROR_GENERAL_ERR	一般的なインストーラー エラー	特定のインストーラー エラーがないエラーが発生しました。
ODBC_ERROR_INVALID_DSN	無効な DSN	lpszDSN 引数には、DSN に無効な文字列が含まれていました。
ODBC_ERROR_INVALID_NAME	ドライバーまたはトランスレーター名が無効です	lpszDriver 引数が無効です。
ODBC_ERROR_REQUEST_FAILED	要求が失敗しました	インストーラーがレジストリに DSN を作成できませんでした。
ODBC_ERROR_OUT_OF_MEM	メモリ不足	メモリ不足のため、インストーラーで関数を実行できませんでした。

説明

SQLWriteDSNToIni は 、システム情報の [ODBC データ ソース] セクションにデータ ソースを追加します。 次に、データ ソースの仕様セクションを作成し、ドライバー DLL の名前を値として 1 つのキーワード (Driver) を追加します。 データ ソース仕様セクションが既に存在する場合、 SQLWriteDSNToIni は 新しいセクションを作成する前に古いセクションを削除します。

この関数の呼び出し元は、ドライバー固有のキーワードと値をシステム情報のデータ ソース仕様セクションに追加する必要があります。

データ ソースの名前が Default の場合、 SQLWriteDSNToIni では、システム情報に既定のドライバー仕様セクションも作成されます。

この関数は、セットアップ DLL からのみ呼び出す必要があります。

関連する関数

対象	解決方法については、
データ ソースの追加、変更、または削除	ConfigDSN(セットアップ DLL 内)
データ ソースの追加、変更、または削除	SQLConfigDataSource
システム情報からデータ ソース名を削除する	SQLRemoveDSNFromIni