sp_OASetProperty (Transact-SQL)
platí pro:SQL Server
Nastaví vlastnost objektu OLE na novou hodnotu.
Syntax
sp_OASetProperty objecttoken
, propertyname
, newvalue
[ , index... ]
[ ; ]
Argumenty
Důležitý
Argumenty rozšířených uložených procedur musí být zadány v určitém pořadí, jak je popsáno v části Syntaxe. Pokud jsou parametry zadány mimo pořadí, dojde k chybové zprávě.
objektu
Token objektu OLE dříve vytvořený sp_OACreate
.
název vlastnosti
Název vlastnosti objektu OLE, který má být nastaven na novou hodnotu.
newvalue
Nová hodnota vlastnosti a musí být hodnotou příslušného datového typu.
indexu
Parametr indexu. Pokud je zadán, index musí být hodnota příslušného datového typu.
Některé vlastnosti mají parametry. Tyto vlastnosti se nazývají indexované vlastnosti a parametry se nazývají parametry indexu. Vlastnost může mít více parametrů indexu.
Poznámka
Parametry pro tuto uloženou proceduru jsou určeny umístěním, nikoli názvem.
Návratové hodnoty kódu
0
(úspěch) nebo nenulové číslo (selhání), které je celočíselná hodnota HRESULT vrácená objektem AUTOMATIZACE OLE.
Další informace o návratových kódech HRESULT najdete v tématu návratové kódy automatizace OLE a informace o chybách.
Dovolení
Vyžaduje členství v správce systému pevné role serveru nebo spustit oprávnění přímo v této uložené proceduře. Možnost konfigurace procedur Ole Automation serveru musí být povolena, aby bylo možné použít jakýkoli systémový postup související se službou OLE Automation.
Příklady
Následující příklad nastaví HostName
vlastnost (dříve vytvořeného objektu SQLServer
) na novou hodnotu.
EXEC @hr = sp_OASetProperty @object,
'HostName',
'Gizmo';
IF @hr <> 0
BEGIN
EXEC sp_OAGetErrorInfo @object
RETURN
END;
Související obsah
- uložené procedury OLE Automation (Transact-SQL)
- ukázkový skript pro automatizaci OLE