Compartir vía


sp_OASetProperty (Transact-SQL)

Se aplica a: SQL Server

Establece un nuevo valor para una propiedad de un objeto OLE.

Convenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

objecttoken

Token de objeto de un objeto OLE creado anteriormente por sp_OACreate.

propertyname

Nombre de propiedad del objeto OLE que se va a establecer en un nuevo valor.

newvalue

El nuevo valor de la propiedad y debe ser un valor del tipo de datos adecuado.

índice

Parámetro de índice. Si se especifica, index debe ser un valor del tipo de datos adecuado.

Algunas propiedades tienen parámetros. Estas propiedades se llaman propiedades indizadas y los parámetros se llaman parámetros de índice. Una propiedad puede tener varios parámetros de índice.

Nota:

Los parámetros de este procedimiento almacenado se especifican por posición, no por nombre.

Valores de código de retorno

0 (correcto) o un número distinto de cero (error) que es el valor entero del HRESULT devuelto por el objeto OLE Automation.

Para obtener más información sobre los códigos de retorno HRESULT, consulte Códigos de retorno y información de error de automatización OLE.

Permisos

Requiere la pertenencia al rol fijo de servidor sysadmin o ejecutar el permiso directamente en este procedimiento almacenado. La opción de configuración del servidor Procedimientos de Ole Automation debe estar habilitada para usar cualquier procedimiento del sistema relacionado con OLE Automation.

Ejemplos

En el ejemplo siguiente se establece la HostName propiedad (del objeto creado SQLServer anteriormente) en un nuevo valor.

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

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;