Share via

  • Статья

sp_OASetProperty (Transact-SQL)

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

Значок ссылки на разделСинтаксические обозначения в 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