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

语法

sp_OASetProperty objecttoken,

    propertyname,

    newvalue

    [ , index... ]

参数

objecttoken

是先前用 sp_OACreate 创建的 OLE 对象令牌。

propertyname

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

newvalue

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

index

是索引参数。如果指定，那么它必须是适当数据类型的值。

一些属性带有参数。这些属性称为索引化属性，其参数被称为索引参数。一个属性可有多个索引参数。

说明  此存储过程的参数按位置指定，而不是按名称。

返回代码值

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

有关 HRESULT 返回代码的更多信息，请参见 OLE 自动化返回代码和错误信息。

权限

只有 sysadmin 固定服务器角色的成员才能执行 sp_OASetProperty。

示例

下面的示例将 HostName 属性（属于先前创建的 SQLServer 对象）设置为新值。

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