sp_OASetProperty (Transact-SQL)

Artigo
12/22/2023

Aplica-se a:SQL Server

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

Sintaxe

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

Argumentos

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.

novovalor
É o novo valor da propriedade, que deve ser do tipo de dados apropriado.

index
É um parâmetro de índice. Se especificado, o índice deve 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.

Valores do código de retorno

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 Códigos de retorno de automação OLE e informações de erro.

Permissões

Requer associação à função de servidor fixa sysadmin ou permissão de execução diretamente neste Procedimento Armazenado. Ole Automation Procedures a configuração deve estar habilitada para usar qualquer procedimento do sistema relacionado à automação OLE.

Exemplos

O exemplo a seguir define a HostName propriedade (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'

Confira também

Procedimentos armazenados de automação OLE (Transact-SQL)
Script de exemplo de automação