sp_OASetProperty (Transact-SQL)

  • [アーティクル]

適用対象:SQL Server

OLE オブジェクトのプロパティを新しい値に設定します。

Transact-SQL 構文表記規則

構文

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

引数

objecttoken
sp_OACreateによって以前に作成された OLE オブジェクトのオブジェクト トークンです。

propertyname
新しい値に設定する OLE オブジェクトのプロパティ名を指定します。

newvalue
プロパティの新しい値を指定します。指定する場合は、適切なデータ型の値にする必要があります。

インデックス
インデックス パラメーターです。 指定する場合、 インデックス は適切なデータ型の値である必要があります。

一部のプロパティにはパラメーターがあります。 これらのプロパティはインデックス付きプロパティと呼ばれ、パラメーターはインデックス パラメーターと呼ばれます。 プロパティには、複数のインデックス パラメーターを指定できます。

Note

このストアド プロシージャのパラメーターは、名前ではなく位置によって指定されます。

リターン コードの値

0 (成功) または 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 オートメーションのサンプル スクリプト