sp_OASetProperty (Transact-SQL)

Define uma propriedade de um objeto OLE como um novo valor.

Sintaxe

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

objecttoken
É o token de objeto de um objeto OLE que foi criado anteriormente por sp_OACreate.
propertyname
É o nome de propriedade do objeto OLE a ser definido como um novo valor.
newvalue
É o novo valor da propriedade, que deve ser do tipo de dados apropriado.
index
É um parâmetro de índice. Se for especificado, index deverá ser um valor do tipo de dados apropriado.

Algumas propriedades têm parâmetros. Estas propriedades são chamadas de propriedades indexadas e os parâmetros são chamados de parâmetros de índice. Uma propriedade pode ter vários parâmetros de índice.

Observação

Os parâmetros deste procedimento armazenado são especificados por posição, não por nome.

Observação
Os parâmetros deste procedimento armazenado são especificados por posição, não por nome.

0 (êxito) ou um número diferente de zero (falha) que é o valor inteiro do HRESULT retornado pelo objeto de Automação OLE.

Para obter mais informações sobre Códigos de Retorno HRESULT, consulte Informações sobre erros e códigos de retorno de automação OLE.

Exige associação à função de servidor fixa sysadmin.

O exemplo a seguir define a propriedade HostName (do objeto SQLServer criado anteriormente) como um novo valor.

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