フォーマット ファイルから各列の書式情報を読み取ります。
構文
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
メモリ不足エラー。
予期しないエラー
メソッドの呼び出しが予期されませんでした。 たとえば、 IBCPSession::BCPInit メソッドは、このメソッドを呼び出す前に呼び出されませんでした。