sp_OASetProperty (Transact-SQL)

  • 發行項

適用於：SQL Server

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

Transact-SQL 語法慣例

語法

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

引數

objecttoken

先前由 sp_OACreate建立之 OLE 對象的物件標記。

propertyname

要設定為新值的 OLE 物件屬性名稱。

newvalue

屬性的新值，而且必須是適當數據類型的值。

index

索引參數。 如果指定， 索引 必須是適當數據類型的值。

某些屬性具有參數。 這些屬性稱為索引屬性，而且參數稱為索引參數。 屬性可以有多個索引參數。

注意

這個預存程式的參數是由位置指定，而不是名稱。

傳回碼值

0 （success） 或非零數位 （failure），這是 OLE Automation 物件所傳回之 HRESULT 的整數值。

如需 HRESULT 傳回碼的詳細資訊，請參閱 OLE 自動化傳回碼和錯誤資訊。

權限

需要系統管理員固定伺服器角色的成員資格，或直接在此預存程式上執行許可權。 必須啟用 [Ole Automation Procedures] 伺服器組態選項，才能使用任何與 OLE Automation 相關的系統程式。

範例

下列範例會將 HostName 屬性 （先前建立 SQLServer 的物件） 設定為新的值。

EXEC @hr = sp_OASetProperty @object,
    'HostName',
    'Gizmo';

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;

相關內容