Partilhar via


sp_OASetProperty (Transact-SQL)

Aplica-se a:SQL Server

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

Transact-SQL convenções de sintaxe

Sintaxe

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

Argumentos

Importante

Os argumentos para procedimentos armazenados estendidos devem ser inseridos na ordem específica, conforme descrito na seção de sintaxe. Se os parâmetros forem inseridos fora de ordem, ocorrerá uma mensagem de erro.

objecttoken

O token de objeto de um objeto OLE criado anteriormente por sp_OACreate.

propriedade

O nome da propriedade do objeto OLE a ser definido como um novo valor.

novovalor

O novo valor da propriedade e deve ser um valor do tipo de dados apropriado.

índice

Um parâmetro de índice. Se especificado, índice deve ser um valor do tipo de dados apropriado.

Algumas propriedades têm parâmetros. Essas 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 para este procedimento armazenado são especificados por posição, não por nome.

Valores de 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 ao sysadmin função de servidor fixa ou permissão de execução diretamente neste procedimento armazenado. A opção Ole Automation Procedures configuração do servidor deve ser habilitada para usar qualquer procedimento do sistema relacionado à automação OLE.

Exemplos

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

EXECUTE
    @hr = sp_OASetProperty
    @object,
    'HostName',
    'Gizmo';

IF @hr <> 0
BEGIN
    EXECUTE sp_OAGetErrorInfo @object;
    RETURN;
END