IBCPSession::BCPReadFmt (OLE DB)
適用対象: 
SQL Server Azure SQL データベース Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)
フォーマット ファイルから列ごとにフォーマット情報を読み取ります。
構文
HRESULT BCPReadFmt(
const wchar_t *pwszFormatFile);
解説
BCPReadFmt メソッドは、データ ファイルのデータ形式を指定するフォーマット ファイルからデータを読み取る場合に使用されます。 このメソッドでは、適切なバージョンのフォーマット ファイルを検出することができます。 また、フォーマット ファイルが xml 形式か、または古いスタイルのテキスト形式かを自動的に検出し、フォーマット ファイルに適した動作をします。 OLE DB Driver for SQL Server 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 メソッドが呼び出されなかった場合などです。