Share via


sp_OASetProperty (Transact-SQL)

將 OLE 物件的屬性設為新值。

主題連結圖示Transact-SQL 語法慣例

語法

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

引數

  • objecttoken
    這是 sp_OACreate 先前所建立之 OLE 物件的物件 Token。

  • propertyname
    這是要設為新值的 OLE 物件屬性名稱。

  • newvalue
    這是屬性的新值,必須是適當資料類型的值。

  • index
    這是一個索引參數。如果指定的話,index 必須是適當資料類型的值。

    部份屬性有參數。這些屬性稱為索引屬性,參數稱為索引參數。一個屬性可以有多個索引參數。

    [!附註]

    這個預存程序的參數是依照位置來指定,而不是名稱。

傳回碼值

0 (成功) 或非零數字 (失敗),這個數字是 OLE Automation 物件所傳回之 HRESULT 的整數值。

如需有關 HRESULT 傳回碼的詳細資訊,請參閱<OLE Automation 傳回碼與錯誤資訊>。

權限

需要系統管理員 (sysadmin) 固定伺服器角色中的成員資格。

範例

下列範例會設定要設為新值的 HostName 屬性 (先前建立的 SQLServer 物件的屬性)。

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