• [アーティクル]

IBCPSession::BCPWriteFmt (OLE DB)

フォーマット ファイルに列ごとのフォーマット情報を書き込みます。

構文

HRESULT BCPWriteFmt( 
      const wchar_t *pwszFormatFile);

説明

フォーマット ファイルでは、一括コピーで作成されるデータ ファイルのデータの形式を指定します。IBCPSession::BCPColumns メソッドと IBCPSession::BCPColFmt メソッドの呼び出しでは、データ ファイルの形式を定義します。BCPWriteFmt メソッドでは、この定義を pwszFormatFile 引数で参照されるファイルに保存します。

BCPWriteFmt メソッドでは、XML 形式またはテキスト形式のいずれかの形式でフォーマット ファイルを保存できます。そのためには、BCP_OPTION_XML 制御オプションを指定して IBCPSession::BCPControl メソッドを使用する必要があります。

保存されたフォーマット ファイルを読み込むには、IBCPSession::BCPReadFmt メソッドを使用します。

注意注意

BCPWriteFmt メソッドで生成されるフォーマット ファイルは、SQL Server 7.0 以降のバージョンで配布されるバージョンの bcp ユーティリティでのみサポートされます。

引数

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

リターン コード値

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

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

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

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

関連項目

概念

一括コピー操作の実行

その他の技術情報

IBCPSession (OLE DB)