IBCPSession::BCPWriteFmt (OLE DB)

适用于:SQL Server Azure SQL 数据库 Azure SQL 托管实例 Azure Synapse Analytics Analytics Platform System (PDW)

下载 OLE DB 驱动程序

将每一列的格式信息写入格式化文件。

语法

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);  

备注

格式化文件指定大容量复制所创建的数据文件的数据格式。 调用 IBCPSession::BCPColumnsIBCPSession::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)
执行大容量复制操作