IBCPSession::BCPWriteFmt (OLE DB)

適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

OLE DB ドライバーのダウンロード

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

構文

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);  

解説

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

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

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

引数

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

リターン コードの値

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

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

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

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

参照

IBCPSession (OLE DB)
一括コピー操作の実行