ISSCommandWithParameters::SetParameterProperties (OLE DB)
按照序号基于每个参数设置参数属性,或者通过指定 SSPARAMPROPS 结构数组来设置大容量参数属性。
语法
HRESULT SetParameterProperties(
DB_UPARAMS cParams,
SSPARAMPROPS rgParamProperties[]);
参数
cParams[in]
rgParamProperties 数组中 SSPARAMPROPS 结构的数量 。 如果此数字为零, ISSCommandWithParameters::SetParameterProperties
将删除可能已为命令中的任何参数指定的所有属性。
rgParamProperties[in]
要设置的 SSPARAMPROPS 结构数组。
返回代码值
方法 ISSCommandWithParameters::SetParameterProperties
返回与核心 OLE DB ICommandProperties::SetProperties 方法相同的错误代码。
备注
使用此方法设置参数属性时,可以按序号进行设置,也可以在从属性数组生成 SSPARAMPROPS 后通过单个 ISSCommandWithParameters::SetParameterProperties
调用来设置参数属性。
在调用ISSCommandWithParameters::SetParameterProperties
方法之前,必须调用 SetParameterInfo 方法。 调用 SetParameterProperties(0, NULL)
可清除所有指定的参数属性,而调用 SetParameterInfo(0,NULL,NULL)
则会清除所有参数信息(包括可能与某个参数相关的任何属性)。
调用 ISSCommandWithParameters::SetParameterProperties
以指定类型不是DBTYPE_XML或DBTYPE_UDT类型的参数的属性将返回DB_E_ERRORSOCCURRED或DB_S_ERRORSOCCURRED,并使用 DBPROPSTATUS_NOTSET标记该参数的 SSPARAMPROPS 中包含的所有 DBPROPS 的 dwStatus 字段。 应当遍历 SSPARAMPROPS 中包含的每个 DBPROPSET 的 DBPROP 数组,以检测 DB_E_ERRORSOCCURRED 或 DB_S_ERRORSOCCURRED 引用了哪些参数。
如果 ISSCommandWithParameters::SetParameterProperties
调用 以指定尚未使用 SetParameterInfo 设置其参数信息的参数的属性,提供程序将返回E_UNEXPECTED,并显示以下错误消息:
在没有先调用 SetParameterInfo 方法的情况下,不能为指定参数调用 SetParameterProperties 方法。 在设置参数属性之前,必须首先设置参数信息。
如果对 的 ISSCommandWithParameters::SetParameterProperties
调用包含已设置参数信息的一些参数,以及尚未设置参数信息的某些参数,则 SSPARAMPROPS 属性集的 DBPROPSET 中的 dwStatus 属性将返回DBSTATUS_NOTSET。
SSPARAMPROPS 结构的定义如下所示:
struct SSPARAMPROPS {
DBORDINAL iOrdinal;
ULONG cPropertySets;
DBPROPSET *rgPropertySets;
};
从 SQL Server 2012 开始,数据库引擎中的改进使 ISSCommandWithParameters::SetParameterProperties 能够更准确地描述预期结果。 这些更准确的结果可能与旧版 SQL Server 中 ISSCommandWithParameters::SetParameterProperties 返回的值有所不同。 有关详细信息,请参阅元数据发现。
成员 | 说明 |
---|---|
iOrdinal | 所传递参数的序号。 |
cPropertySets | rgPropertySets 中 DBPROPSET 结构的数量 。 |
rgPropertySets | 指向内存中将返回 DBPROPSET 结构数组的位置的指针。 |