sp_OASetProperty (Transact-SQL)

Статья
12/22/2023

Применимо к:SQL Server

Устанавливает новое значение свойства OLE-объекта.

Синтаксис

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

Аргументы

objecttoken
Является маркером объекта OLE, который ранее был создан sp_OACreate.

propertyname
Имя свойства OLE-объекта, которому присваивается новое значение.

Newvalue
Новое значение свойства должно быть величиной соответствующего типа данных.

index
Индексный параметр. Если задано, индекс должен быть значением соответствующего типа данных.

Некоторые свойства имеют параметры. Эти свойства называются индексированными свойствами, а параметры — индексными параметрами. Свойство может иметь несколько индексных параметров.

Примечание.

Параметры для этой хранимой процедуры задаются по положению, а не по имени.

Значения кода возврата

0 (успешное завершение) или ненулевое число (неуспешное завершение), которое является целочисленным значением типа HRESULT, возвращаемого объектом OLE-автоматизации.

Дополнительные сведения о кодах возврата HRESULT см. в разделе "Коды возврата автоматизации OLE" и сведения об ошибках.

Разрешения

Требуется членство в предопределенных ролях сервера sysadmin или разрешение на выполнение непосредственно в этой хранимой процедуре. Ole Automation Procedures Необходимо включить настройку для использования любой системной процедуры, связанной с автоматизацией OLE.

Примеры

В следующем примере свойство (ранее созданного объекта SQLServer) присваивается HostName новому значению.

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

См. также

Хранимые процедуры OLE Automation (Transact-SQL)
Пример скрипта OLE-автоматизации