• [アーティクル]

IBCPSession::BCPReadFmt (OLE DB)

フォーマット ファイルから列ごとにフォーマット情報を読み取ります。

構文

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 メソッドで参照できるファイルに、ユーザー定義のデータ形式を保存することもできます。

引数

  • pwszFormatFile[in]
    データ ファイルのフォーマット情報を含むファイルのパスとファイル名。

リターン コード値

  • S_OK
    メソッドが成功しました。

  • E_FAIL
    プロバイダ固有のエラーが発生しました。エラーの詳細を確認するには、ISQLServerErrorInfo インターフェイスを使用してください。

  • E_OUTOFMEMORY
    メモリ不足エラーです。

  • E_UNEXPECTED
    メソッドの呼び出しが予期されませんでした。たとえば、このメソッドが呼び出される前に、IBCPSession::BCPInit メソッドが呼び出されなかった場合などです。

関連項目

概念

一括コピー操作の実行

その他の技術情報

IBCPSession (OLE DB)