sp_OASetProperty (Transact-SQL)
Sets a property of an OLE object to a new value.
.gif "Topic link icon")
Transact-SQL Syntax Conventions
Syntax
sp_OASetProperty objecttoken , propertyname , newvalue [ , index... ]
Arguments
- objecttoken
Is the object token of an OLE object that was previously created by sp_OACreate.
- propertyname
Is the property name of the OLE object to set to a new value.
- newvalue
Is the new value of the property, and must be a value of the appropriate data type.
index
Is an index parameter. If specified, index must be a value of the appropriate data type.Some properties have parameters. These properties are called indexed properties, and the parameters are called index parameters. A property can have multiple index parameters.
Note
The parameters for this stored procedure are specified by position, not name.
Return Code Values
0 (success) or a nonzero number (failure) that is the integer value of the HRESULT returned by the OLE Automation object.
For more information about HRESULT Return Codes, see OLE Automation Return Codes and Error Information.
Permissions
Requires membership in the sysadmin fixed server role.
Examples
The following example sets the HostName property (of the previously created SQLServer object) to a new value.
EXEC @hr = sp_OASetProperty @object, 'HostName', 'Gizmo'
IF @hr <> 0
BEGIN
EXEC sp_OAGetErrorInfo @object
RETURN
END
See Also
Reference
OLE Automation Stored Procedures (Transact-SQL)