Partager via


sp_OASetProperty (Transact-SQL)

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

Icône Lien de rubriqueConventions de la syntaxe de 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 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. S'il est spécifié, 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 par nom.

Valeurs des codes retournés

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 retournés par HRESULT, consultez Codes de retour OLE Automation et informations sur les erreurs.

Autorisations

Nécessite l'appartenance au rôle de serveur fixe sysadmin.

Exemple

Cet exemple affecte une nouvelle valeur à la propriété HostName (de l'objet SQLServer précédemment créé).

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