sp_OASetProperty (Transact-SQL)

Artikel
12/22/2023

Legt für eine Eigenschaft eines OLE-Objekts einen neuen Wert fest.

Syntax

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

Argumente

objecttoken
Ist das Objekttoken eines OLE-Objekts, das zuvor von sp_OACreate erstellt wurde.

propertyname
Der Eigenschaftsname des OLE-Objekts, dessen Wert neu festgelegt wird

Newvalue
Der neue Wert der Eigenschaft, der den entsprechenden Datentyp aufweisen muss

Index
Ein Indexparameter. Wenn angegeben, muss index ein Wert des entsprechenden Datentyps sein.

Einige Eigenschaften besitzen Parameter. Diese Eigenschaften werden als Indiziert-Eigenschaften und die Parameter als Indexparameter bezeichnet. Eine Eigenschaft kann mehrere Indexparameter aufweisen.

Hinweis

Die Parameter für diese gespeicherte Prozedur werden durch Position und nicht durch den Namen angegeben.

Rückgabecodewerte

0 (Erfolg) oder eine Zahl ungleich Null (Fehler), die dem ganzzahligen Wert von HRESULT entspricht, der vom OLE-Automatisierungsobjekt zurückgegeben wird.

Weitere Informationen zu HRESULT-Rückgabecodes finden Sie unter OLE Automation Return Codes and Error Information.

Berechtigungen

Erfordert die Mitgliedschaft in der festen Serverrolle "sysadmin " oder führt die Berechtigung direkt für diese gespeicherte Prozedur aus. Ole Automation ProceduresDie Konfiguration muss aktiviert sein, um alle Systemprozeduren im Zusammenhang mit der OLE-Automatisierung zu verwenden.

Beispiele

Im folgenden Beispiel wird die HostName Eigenschaft (des zuvor erstellten SQLServer-Objekts ) auf einen neuen Wert festgelegt.

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

Weitere Informationen

Gespeicherte OLE-Automatisierungsprozeduren (Transact-SQL)
OLE-Automatisierungsbeispielskript