从格式化文件中读取每列的格式信息。
语法
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 方法引用的文件中保存用户定义的数据格式。
BCP_OPTION_DELAYREADFMT
IBCPSession::BCPControl 的 eOption 参数的值修改 IBCPSession::BCPReadFmt 的行为。
论据
pwszFormatFile[in]
包含数据文件的格式值的文件的路径和文件名。
返回代码值
S_OK
方法成功。
E_FAIL
出现提供程序特定的错误,有关详细信息,请使用 ISQLServerErrorInfo 接口。
E_OUTOFMEMORY
内存不足错误。
E_UNEXPECTED
对方法的调用是意外的。 例如,在调用此方法之前,未调用 IBCPSession::BCPInit 方法。