Compartilhar via

sp_OASetProperty (Transact-SQL)

Aplica-se:SQL Server

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

Convenções de sintaxe de Transact-SQL

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 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 pelo sp_OACreate.

propertyname

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

Novo valor

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

index

Um parâmetro de índice. Se especificado, index 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 (sucesso) 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 na função de servidor fixa sysadmin ou permissão de execução diretamente nesse procedimento armazenado. A opção de configuração do servidor Ole Automation Procedures deve ser habilitada para usar qualquer procedimento do sistema relacionado ao OLE Automation.

Exemplos

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

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

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

Conteúdo relacionado

  • Last updated on