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