sp_OASetProperty (Transact-SQL)

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

Cинтаксические обозначения в Transact-SQL

Синтаксис

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

Аргументы

• objecttoken
  Токен OLE-объекта, предварительно созданный с помощью процедуры sp_OACreate.

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

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

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

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

  Примечание

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

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

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

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

Разрешения

Требуется членство в предопределенной роли сервера sysadmin.

Примеры

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

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

См. также

Справочник

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

Пример скрипта OLE-автоматизации