sp_OASetProperty (Transact-SQL)

Article
12/22/2023

S’applique à :SQL Server

Affecte une nouvelle valeur à une propriété d'un objet OLE.

Syntaxe

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

Arguments

objecttoken
Jeton d’objet d’un objet OLE créé précédemment par sp_OACreate.

propertyname
Nom de la propriété de l'objet OLE à laquelle une nouvelle valeur doit être affectée.

Newvalue
Nouvelle valeur de la propriété, ce 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.

Codet de retour

0 (succès) ou un nombre différent de zéro (échec), qui représente la valeur entière de HRESULT renvoyée par l'objet OLE Automation.

Pour plus d’informations sur les codes de retour HRESULT, consultez OLE Automation Return Codes and Error Information.

Autorisations

Nécessite l’appartenance au rôle serveur fixe sysadmin ou l’autorisation d’exécution directement sur cette procédure stockée. Ole Automation Procedures la configuration 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 SQLServer précédemment créé) sur une nouvelle valeur.

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

Voir aussi

Procédures stockées OLE Automation (Transact-SQL)
Exemple de script OLE Automation