sp_OASetProperty (Transact-SQL)
適用対象: SQL Server
OLE オブジェクトのプロパティを新しい値に設定します。
構文
sp_OASetProperty objecttoken
, propertyname
, newvalue
[ , index... ]
[ ; ]
引数
objecttoken
sp_OACreate
によって以前に作成された OLE オブジェクトのオブジェクト トークン。
propertyname
新しい値に設定する OLE オブジェクトのプロパティ名。
newvalue
プロパティの新しい値。適切なデータ型の値である必要があります。
インデックス
インデックス パラメーター。 指定する場合、 index は適切なデータ型の値である必要があります。
一部のプロパティにはパラメーターがあります。 これらのプロパティはインデックス付きプロパティと呼ばれ、パラメーターはインデックス パラメーターと呼ばれます。 プロパティには、複数のインデックス パラメーターを指定できます。
Note
このストアド プロシージャのパラメーターは、名前ではなく位置によって指定されます。
リターン コードの値
0
(成功) または 0 以外の数値 (失敗) は、OLE オートメーション オブジェクトによって返される HRESULT の整数値です。
HRESULT 戻りコードの詳細については、 OLE 自動化戻りコードとエラー情報を参照してください。
アクセス許可
sysadmin固定サーバー ロールのメンバーシップが必要です。または、このストアド プロシージャに対して直接アクセス許可を実行します。 OLE オートメーションに関連するシステム プロシージャを使用するには、 Ole Automation Procedures サーバー構成オプションを有効にする必要があります。
例
次の例では、(前に作成したSQLServer
オブジェクトの) HostName
プロパティを新しい値に設定します。
EXEC @hr = sp_OASetProperty @object,
'HostName',
'Gizmo';
IF @hr <> 0
BEGIN
EXEC sp_OAGetErrorInfo @object
RETURN
END;