各列の書式情報をフォーマット ファイルに書き込みます。
構文
HRESULT BCPWriteFmt(
const wchar_t *pwszFormatFile);
注釈
フォーマット ファイルでは、一括コピーで作成されるデータ ファイルのデータの形式を指定します。 IBCPSession::BCPColumns メソッドと IBCPSession::BCPColFmt メソッドの呼び出しによって、データ ファイルの形式が定義されます。 BCPWriteFmt メソッドは、pwszFormatFile 引数によって参照されるファイルにこの定義を保存します。
BCPWriteFmt メソッドは、xml 形式またはテキスト形式でフォーマット ファイルを保存できます。 これは、 IBCPSession::BCPControl メソッドで BCP_OPTION_XML 制御オプションを使用して示す必要があります。
保存したフォーマット ファイルを読み込むには、 IBCPSession::BCPReadFmt メソッドを 使用します。
論争
pwszFormatFile[in]
データ ファイルの形式値を含むファイルのパスとファイル名。
リターン コードの値
S_OK
メソッドは成功しました。
E_FAIL
プロバイダー固有のエラーが発生しました。詳細については、 ISQLServerErrorInfo インターフェイスを使用してください。
E_OUTOFMEMORY
メモリ不足エラー。
予期しないエラー
メソッドの呼び出しは予期しないものでした。 たとえば、 IBCPSession::BCPInit メソッドは、このメソッドを呼び出す前に呼び出されませんでした。