sp_OASetProperty (Transact-SQL)
Область применения: SQL Server
Устанавливает новое значение свойства OLE-объекта.
Соглашения о синтаксисе Transact-SQL
Синтаксис
sp_OASetProperty objecttoken
, propertyname
, newvalue
[ , index... ]
[ ; ]
Аргументы
objecttoken
Маркер объекта OLE, созданный sp_OACreate
ранее.
propertyname
Имя свойства объекта OLE для задания нового значения.
newvalue
Новое значение свойства и должно быть значением соответствующего типа данных.
index
Параметр индекса. Если задано, индекс должен быть значением соответствующего типа данных.
Некоторые свойства имеют параметры. Эти свойства называются индексированными свойствами, а параметры — индексными параметрами. Свойство может иметь несколько индексных параметров.
Примечание.
Параметры для этой хранимой процедуры задаются по положению, а не по имени.
Значения кода возврата
0
(успешно) или ненулевое число (сбой), которое является целым значением HRESULT, возвращаемым объектом OLE Automation.
Дополнительные сведения о кодах возврата HRESULT см. в разделе "Коды возврата автоматизации OLE" и сведения об ошибках.
Разрешения
Требуется членство в предопределенных ролях сервера sysadmin или разрешение на выполнение непосредственно в этой хранимой процедуре. Параметр конфигурации сервера Ole Automation Procedures должен быть включен для использования любой системной процедуры, связанной с OLE Automation.
Примеры
В следующем примере свойство (ранее созданного SQLServer
объекта) присваивается HostName
новому значению.
EXEC @hr = sp_OASetProperty @object,
'HostName',
'Gizmo';
IF @hr <> 0
BEGIN
EXEC sp_OAGetErrorInfo @object
RETURN
END;