SQLWriteFileDSN 函式

  • 發行項

一致性
引進的版本：ODBC 3.0

摘要
SQLWriteFileDSN 會將資訊寫入檔案 DSN。

語法

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);

引數

lpszFileName
[輸入]檔案 DSN 名稱的指標。 DSN 副檔名會附加至所有尚未具有 DSN 副檔名的檔案名。

lpszAppName
[輸入]應用程式名稱的指標。 這是 ODBC 區段的 「ODBC」。

lpszKeyName
[輸入]要讀取之索引鍵名稱的指標。 請參閱保留關鍵字的「批註」。

lpszString
[輸出]指向要寫入之索引鍵相關聯的字串。 這個引數所指向字串的最大長度為 32，767 個位元組。

傳回

如果函式成功，則傳回 TRUE，如果失敗，則傳回 FALSE。

診斷

當 SQLWriteFileDSN 傳回 FALSE 時 ，可以呼叫 SQLInstallerError 來取得相關聯的 *pfErrorCode 值。 下表列出 SQLInstallerError 可傳 回的 *pfErrorCode 值，並說明此函式內容中的每個值。

*pfErrorCode 錯誤 描述
ODBC_ERROR_GENERAL_ERR 一般安裝程式錯誤 發生錯誤，沒有特定的安裝程式錯誤。
ODBC_ERROR_INVALID_PATH 安裝路徑無效 lpszFileName 引數中指定的 檔案名路徑無效。
ODBC_ERROR_INVALID_REQUEST_TYPE 要求類型無效 lpszAppName 、 lpszKeyName 或 lpszString 引數為 Null。

註解

ODBC 會保留用來儲存連接資訊的區段名稱 [ODBC]。 本節的保留關鍵字與 SQLDriverConnect 中 為連接字串保留的關鍵字相同。 （如需詳細資訊，請參閱 SQLDriverConnect 函式描述。）

應用程式可以使用這些保留關鍵字，將資訊直接寫入檔案 DSN。 如果應用程式想要建立或修改與 File DSN 相關聯的 DSN 無連接字串，它可以針對 [ODBC] 區段中任何保留的連接字串關鍵字呼叫 SQLWriteFileDSN 。

如果 lpszString 引數是 Null 指標，lpszKeyName 引數所指向的 關鍵字將會從 .dsn 檔案中刪除。 如果 lpszString 和 lpszKeyName 引數都是 Null 指標，則 lpszAppName 引數所 指向的區段將會從 .dsn 檔案中刪除。

如需下列資訊 請參閱
從檔案 DSN 讀取資訊 SQLReadFileDSN