IBCPSession：：BCPColFmt （Native Client OLE DB Provider）
适用于：
SQL Server Azure SQL 数据库 Azure SQL 托管实例 Azure Synapse Analytics Analytics Platform System (PDW)
重要
已从 SQL Server 2022 (16.x) 和 SQL Server Management Studio 19 (SSMS) 中移除 SQL Server Native Client（通常缩写为 SNAC）。 不建议在新的开发工作中使用 SQL Server Native Client OLE DB 提供程序（SQLNCLI 或 SQLNCLI11）和旧版 Microsoft OLE DB Provider for SQL Server (SQLOLEDB)。 此后请切换到新的 Microsoft OLE DB Driver (MSOLEDBSQL) for SQL Server。
在程序变量与 SQL Server 列之间创建绑定。
语法
HRESULT BCPColFmt(
DBORDINAL idxUserDataCol,
int eUserDataType,
int cbIndicator,
int cbUserData,
BYTE *pbUserDataTerm,
int cbUserDataTerm,
DBORDINAL idxServerCol);
备注
BCPColFmt 方法用于在 BCP 数据文件字段和 SQL Server 列之间创建绑定。 它将列的长度、类型、终止符和前缀长度视为参数处理，并为各个字段设置所有这些属性。
如果用户选择交互模式，则调用该方法两次；一次按照默认值（与服务器列的类型相对应）设置列格式，另一次按照在交互模式期间选择的客户端的所选列类型为每个列设置格式。
在非交互模式中，对每列只调用它一次，以便将每个列的类型设置为字符或本机类型，并设置列和行终止符。
使用 BCPColFmt 方法可以为大容量复制指定用户文件格式 。 对于大容量复制，格式包含以下部分：
从用户文件字段到数据库列的映射。
每个用户文件字段的数据类型。
每个字段的可选指示器的长度。
每个用户文件字段中数据的最大长度。
每个字段的可选终止字节序列。
可选终止字节序列的长度。
对 BCPColFmt 的每次调用将指定一个用户文件字段的格式。 例如，要在具有 5 个字段的用户数据文件中更改 3 个字段的默认设置，请先调用 BCPColumns(5)，再调用 BCPColFmt 五次，其中三次调用设置自定义格式。 对于剩余的两次调用，请将 eUserDataType 设置为 BCP_TYPE_DEFAULT，并将 cbIndicator、cbUserData 和 cbUserDataTerm 分别设置为 0、BCP_VARIABLE_LENGTH 和 0。 此过程复制全部五列，其中的三列采用您的自定义格式，另两列采用默认格式。
注意
在对 BCPColFmt 进行任何调用之前，必须先调用 IBCPSession::BCPColumns 方法。 必须对用户文件中的每个列调用一次 BCPColFmt。 对任何用户文件列多次调用 BCPColFmt 将导致错误。
不必将用户文件中的所有数据复制到 SQL Server 表。 若要跳过某一列，请指定该列的数据格式，并且将 idxServerCol 参数设置为 0。 若要跳过某一字段，仍然需要所有信息才能让该方法正常工作。
注意IBCPSession::BCPWriteFmt 函数可以用于持久化通过 BCPColFmt 提供的格式规范。
参数
idxUserDataCol[in]
用户的数据文件中字段的索引。
eUserDataType[in]
用户的数据文件中字段的数据类型。 可用数据类型列在 SQL Server Native Client 头文件（sqlncli.h）中，BCP_TYPE_XXX格式，例如BCP_TYPE_SQLINT4。 如果指定 BCP_TYPE_DEFAULT 值，则访问接口将尝试使用与表或视图列相同的类型。 当 eUserDataType 参数是 BCP_TYPE_SQLDECIMAL 或 BCP_TYPE_SQLNUMERIC 时，对于源为 SQL Server 和目标为文件的大容量复制操作：
如果源列的数据类型不是 decimal 或 numeric，则使用默认的精度和小数位数。
如果源列的数据类型是 decimal 或 numeric，则使用源列的精度和小数位数。
cbIndicator[in]
字段的前缀长度。 默认是 BCP_PREFIX_DEFAULT。 前缀的有效长度是 0、1、2、4 和 8。 大多数情况下，使用等于 8 的前缀大小指示字段已块区化。 这用于有效地大容量复制大型值类型列。
cbUserData[in]
用户文件中该字段的数据的最大长度（单位为字节），不包括任何长度指示器或终止符的长度。
如果将 cbUserData 设置为 BCP_LENGTH_NULL，则指示数据文件字段中的所有值已经或应当设置为 NULL。 如果将 cbUserData 设置为 BCP_LENGTH_VARIABLE，则指示系统应当确定每个字段的数据的长度。 对于某些字段，这可能意味着将生成长度/Null 指示器，并将该指示器放在从 SQL Server 复制的数据的前面，或者应当将该指示器放在复制到 SQL Server 的数据中。
对于 SQL Server 字符和二进制数据类型，cbUserData可以是 BCP_LENGTH_VARIABLE、BCP_LENGTH_NULL、0 或某个正值。 如果 cbUserData 是 BCP_LENGTH_VARIABLE，则系统使用长度指示器（如果有）或终止符序列来确定数据的长度。 如果长度指示符和终止符序列均提供，则大容量复制将采用导致数据复制量最少的方法。 如果 cbUserData 是 BCP_LENGTH_VARIABLE，而且数据类型是 SQL Server 字符或二进制类型，并且长度指示器和终止符序列均未指定，则系统返回错误消息。
如果 cbUserData 为 0 或正值，则系统使用 cbUserData 作为最大数据长度 。 但是，如果除了正的 cbUserData 以外，还提供了长度指示器或终止符序列，则系统使用导致数据复制量最少的方法来确定数据长度。
cbUserData 值表示数据的字节计数。 如果字符数据由 Unicode 宽字符表示，则正的 cbUserData 参数值表示字符数乘以每个字符大小（字节）。
pbUserDataTerm[size_is][in]
用于字段的终止符序列。 此参数主要用于字符数据类型，因为所有其他类型均属于固定长度，或者在二进制数据的情况下，要求长度指示器以精确记录提供的字节数目。
为了避免终止提取的数据，或者指示用户文件中的数据不终止，可将此参数设置为 NULL。
如果使用多种方法指定用户文件列长度（例如终止符和长度指示器，或者终止符和最大列长度），则大容量复制选择导致数据复制量最少的方法。
大容量复制 API 根据需要执行 Unicode 到 MBCS 的字符转换。 执行此操作时请务必小心，以便确保终止符字节字符串和字节字符串的长度都正确设置。
cbUserDataTerm[in]
要用于列的终止符序列的长度（单位为字节）。 如果终止符不存在或不希望其出现在数据中，请将该值设置为 0。
idxServerCol[in]
数据库表中列的序号位置。 第一个列编号为 1。 列的序号位置由 IColumnsInfo::GetColumnInfo 或类似方法报告。 如果该值是 0，则大容量复制将忽略数据文件中的相应字段。
返回代码值
S_OK
方法成功。
E_FAIL
出现访问接口特定的错误；要获取详细信息，请使用 ISQLServerErrorInfo 接口。
E_UNEXPECTED
意外调用了该方法。 例如，在调用该方法之前，未调用 IBCPSession::BCPInit 方法。
E_INVALIDARG
参数无效。
E_OUTOFMEMORY
内存不足错误。