sp_OASetProperty (Transact-SQL)
S'applique à : SQL Server
Affecte une nouvelle valeur à une propriété d'un objet OLE.
Conventions de la syntaxe Transact-SQL
Syntaxe
sp_OASetProperty objecttoken
, propertyname
, newvalue
[ , index... ]
[ ; ]
Arguments
objecttoken
Jeton d’objet d’un objet OLE précédemment créé par sp_OACreate
.
propertyname
Nom de propriété de l’objet OLE à définir sur une nouvelle valeur.
newvalue
La nouvelle valeur de la propriété et doit être une valeur du type de données approprié.
index
Paramètre d’index. Si spécifié, l’index doit être une valeur du type de données approprié.
Certaines propriétés possèdent des paramètres. Elles sont désignées sous le nom de propriétés indexées, et les paramètres s'appellent des paramètres d'index. Une propriété peut posséder plusieurs paramètres d'index.
Remarque
Les paramètres pour cette procédure stockée sont spécifiés par position et non pas par nom.
Valeurs des codes de retour
0
(réussite) ou nombre différent de zéro (échec) qui est la valeur entière du HRESULT retourné par l’objet OLE Automation.
Pour plus d’informations sur les codes de retour HRESULT, consultez les codes de retour OLE Automation et les informations d’erreur.
autorisations
Nécessite l’appartenance au rôle serveur fixe sysadmin ou l’autorisation d’exécution directement sur cette procédure stockée. L’option de configuration du serveur Procédures Ole Automation doit être activée pour utiliser n’importe quelle procédure système liée à OLE Automation.
Exemples
L’exemple suivant définit la HostName
propriété (de l’objet créé SQLServer
précédemment) sur une nouvelle valeur.
EXEC @hr = sp_OASetProperty @object,
'HostName',
'Gizmo';
IF @hr <> 0
BEGIN
EXEC sp_OAGetErrorInfo @object
RETURN
END;