sp_OASetProperty (Transact-SQL)

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

Icono de vínculo a temasConvenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

  • objecttoken
    Es el token de un objeto OLE creado anteriormente con sp_OACreate.

  • propertyname
    Es el nombre de la propiedad del objeto OLE que se va establecer en un nuevo valor.

  • newvalue
    Es el nuevo valor de la propiedad y debe ser un valor del tipo de datos apropiado.

  • index
    Es un 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 la posición, no por el nombre.

Valores de código de retorno

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

Para obtener más información acerca de los códigos de retorno HRESULT, vea Códigos de retorno e información de error de automatización OLE.

Permisos

Debe pertenecer a la función fija de servidor sysadmin.

Ejemplos

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

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