sp_OASetProperty (Transact-SQL)

适用于:SQL Server

将 OLE 对象的属性设置为新值。

Transact-SQL 语法约定

语法

  
sp_OASetProperty objecttoken , propertyname , newvalue [ , index... ]  

参数

objecttoken
以前由 sp_OACreate创建的 OLE 对象的对象标记。

propertyname
要设置新值的 OLE 对象的属性名。

newvalue
属性的新值,并且必须是适当数据类型的值。

索引
索引参数。 如果指定, 索引 必须是相应数据类型的值。

有些属性包含参数。 这些属性称为索引化属性,相应的参数被称为索引参数。 一个属性可有多个索引参数。

注意

此存储过程的参数按位置(而不是按名称)指定。

返回代码值

0(成功)或非零数字(失败),是由 OLE 自动化对象返回的 HRESULT 整数值。

有关 HRESULT 返回代码的详细信息,请参阅 OLE 自动化返回代码和错误信息

权限

需要 sysadmin 固定服务器角色的成员身份或直接在此存储过程上执行权限。 Ole Automation Procedures 必须 启用 配置才能使用与 OLE 自动化相关的任何系统过程。

示例

以下示例将 HostName 属性(以前创建的 SQLServer 对象)设置为新值。

EXEC @hr = sp_OASetProperty @object, 'HostName', 'Gizmo';  
IF @hr <> 0  
BEGIN  
   EXEC sp_OAGetErrorInfo @object  
    RETURN  
END'  

另请参阅

OLE 自动存储过程 (Transact-SQL)
OLE 自动化脚本示例