IBCPSession：：BCPReadFmt （Native Client OLE DB Provider）
適用於： 
SQL Server Azure SQL 資料庫 Azure SQL 受控執行個體 Azure Synapse Analytics Analytics 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 BCPReadFmt(
const wchar_t *pwszFormatFile);
備註
BCPReadFmt 方法是用來讀取格式檔案中的資料 (格式檔案會指定資料檔中的資料格式)。 這個方法能夠偵測格式檔案的正確版本。 它可以自動偵測格式檔案為 xml 還是舊樣式的文字格式，並適當地產生行為。 SQL Server Native Client OLE DB 提供者 BCP 支援的格式檔案版本為 6.0 版或更新版本。
當 BCPReadFmt 方法讀取格式值以後，它會適當地呼叫 IBCPSession::BCPColumns 和 IBCPSession::BCPColFmt 方法。 使用者不需要剖析格式檔案，也不需要進行這些呼叫。
若要儲存格式檔案，請呼叫 IBCPSession::BCPWriteFmt 方法。 BCPReadFmt 方法的呼叫可以參考已儲存的格式。 另外，大量複製公用程式 (bcp) 可以將使用者定義的資料格式儲存在由 BCPReadFmt 方法參考的檔案中。
IBCPSession::BCPControl 之 eOption 參數的 BCP_OPTION_DELAYREADFMT 值會修改 IBCPSession::BCPReadFmt 的行為。
引數
pwszFormatFile[in]
包含資料檔案式值之檔案的路徑和檔案名稱。
傳回碼值
S_OK
此方法已成功。
E_FAIL
發生提供者特定的錯誤，如需詳細資訊，請使用 ISQLServerErrorInfo 介面。
E_OUTOFMEMORY
記憶體不足的錯誤。
E_UNEXPECTED
此方法的呼叫是非預期的。 例如，在呼叫這個方法之前，不會呼叫 IBCPSession::BCPInit 方法。