IBCPSession：：BCPWriteFmt （Native Client OLE DB Provider）

適用於：SQL ServerAzure SQL DatabaseAzure SQL 受控執行個體Azure Synapse AnalyticsAnalytics Platform System (PDW)

重要

SQL Server Native Client (通常縮寫為 SNAC) 已從 SQL Server 2022 (16.x) 和 SQL Server Management Studio 19 (SSMS) 中移除。 不建議使用 SQL Server Native Client OLE DB 提供者 (SQLNCLI 或 SQLNCLI11) 和舊版 Microsoft OLE DB Provider for SQL Server (SQLOLEDB) 進行新的開發。 請切換至新的 Microsoft OLE DB Driver (MSOLEDBSQL) for SQL Server 以繼續使用。

將每個資料行的格式資訊寫入格式檔案。

語法

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);  

備註

格式檔案會指定大量複製所建立之資料檔的資料格式。 IBCPSession::BCPColumns 和 IBCPSession::BCPColFmt 方法的呼叫會定義資料檔案的格式。 BCPWriteFmt 方法會將此定義儲存在 pwszFormatFile 引數參考的檔案中。

BCPWriteFmt 方法可以用 xml 或文字格式儲存格式檔案。 這必須搭配 IBCPSession::BCPControl 方法使用 BCP_OPTION_XML 控制選項指示。

若要載入已儲存的格式檔案，請使用 IBCPSession::BCPReadFmt 方法。

引數

pwszFormatFile[in]
包含資料檔案式值之檔案的路徑和檔案名稱。

傳回碼值

S_OK
此方法已成功。

E_FAIL
發生提供者特有的錯誤，如需詳細資訊，請使用 ISQLServerErrorInfo 介面。

E_OUTOFMEMORY
記憶體不足錯誤

E_UNEXPECTED
此方法的呼叫是非預期的。 例如，在呼叫這個方法之前，不會呼叫 IBCPSession::BCPInit 方法。

另請參閱

IBCPSession (OLE DB)
執行大量複製作業