Partager via

  • Article

Classe UserDefinedMessage

The UserDefinedMessage object represents a user-defined message.

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class UserDefinedMessage _
    Inherits MessageObjectBase _
    Implements ICreatable, IDroppable, IAlterable, IScriptable
'Utilisation
Dim instance As UserDefinedMessage

public sealed class UserDefinedMessage : MessageObjectBase, 
    ICreatable, IDroppable, IAlterable, IScriptable

public ref class UserDefinedMessage sealed : public MessageObjectBase, 
    ICreatable, IDroppable, IAlterable, IScriptable

[<SealedAttribute>]
type UserDefinedMessage =  
    class
        inherit MessageObjectBase
        interface ICreatable
        interface IDroppable
        interface IAlterable
        interface IScriptable
    end

public final class UserDefinedMessage extends MessageObjectBase implements ICreatable, IDroppable, IAlterable, IScriptable

Le type UserDefinedMessage expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique UserDefinedMessage() () () () Initializes a new instance of the UserDefinedMessage class.
Méthode publique UserDefinedMessage(Server, Int32) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server and with the specified ID value.
Méthode publique UserDefinedMessage(Server, Int32, String) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server, with the specified ID value and written in the specified language.
Méthode publique UserDefinedMessage(Server, Int32, Int32, Int32, String) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server, with the specified ID value, written in the specified language, the specified severity, and actual message text.
Méthode publique UserDefinedMessage(Server, Int32, String, Int32, String) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server, with the specified ID value, written in the specified language, the specified severity, and actual message text.
Méthode publique UserDefinedMessage(Server, Int32, Int32, Int32, String, Boolean) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server, with the specified ID value, written in the specified language, the specified severity and actual message text, and the option to specify whether the message is logged to the Windows event log.
Méthode publique UserDefinedMessage(Server, Int32, String, Int32, String, Boolean) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server, with the specified ID value, written in the specified language, the specified severity and actual message text, and the option to specify whether the message is logged to the Windows event log.

Haut de la page

Propriétés

  Nom Description
Propriété protégée ExecuteForScalar Obtient ou définit la valeur de la propriété Boolean qui spécifie si l'objet est défini selon l'option permettant l'exécution qui retourne une valeur scalaire. (hérité de SqlSmoObject.)
Propriété publique ID Gets the ID value that uniquely identifies the user-defined message.
Propriété publique IsLogged Gets or sets the Boolean property value that specifies whether the message is logged to the Microsoft Windows event log.
Propriété protégée IsTouched Obtient la valeur de la propriété Boolean qui spécifie si les propriétés de l'objet ont été mises à jour mais n'ont pas encore été rendues persistantes sur le serveur. (hérité de SqlSmoObject.)
Propriété publique Language Gets or sets the language in which the message is written.
Propriété publique LanguageID Gets or sets the ID value that uniquely identifies the language in which the message is written.
Propriété protégée ObjectInSpace Obtient la valeur de la propriété Boolean qui spécifie si l'objet existe dans l'isolation, ou s'il est connecté directement ou indirectement à l'instance de SQL Server. (hérité de SqlSmoObject.)
Propriété publique Parent Gets the Server object that specifies the parent of the UserDefinedMessage object.
Propriété publique Properties Obtient une collection d'objets Property qui représentent les propriétés de l'objet. (hérité de SqlSmoObject.)
Propriété protégée ScalarResult Obtient le résultat scalaire pour l'objet référencé. (hérité de SqlSmoObject.)
Propriété publique Severity Gets or sets the severity of the user-defined message.
Propriété publique State Gets the state of the referenced object. (hérité de SmoObjectBase.)
Propriété publique Text Gets or sets the textual description of the user-defined message.
Propriété publique Urn Obtient la valeur URN (Uniform Resource Name) qui identifie de façon unique l'objet. (hérité de SqlSmoObject.)
Propriété publique UserData Gets or sets user-defined data associated with the referenced object. (hérité de SmoObjectBase.)

Haut de la page

Méthodes

  Nom Description
Méthode protégée AddDatabaseContext(StringCollection) Ajoute le contexte de base de données à la collection de requêtes identifiée par le paramètre queries. (hérité de SqlSmoObject.)
Méthode protégée AddDatabaseContext(StringCollection, ScriptingOptions) Ajoute le contexte de base de données à la collection de requêtes identifiée par le paramètre queries, à l'aide des options de script spécifiées. (hérité de SqlSmoObject.)
Méthode publique Alter Updates any UserDefinedMessage object property changes on the instance of SQL Server. 
Méthode protégée AlterImpl Active l'événement d'objet modifié. (hérité de SqlSmoObject.)
Méthode protégée AlterImplFinish Méthode appelée lorsque l'événement d'objet modifié est terminé. (hérité de SqlSmoObject.)
Méthode protégée AlterImplInit Méthode appelée lorsque l'événement d'objet modifié est initialisé. (hérité de SqlSmoObject.)
Méthode protégée AlterImplWorker Appelle les méthodes de modification. (hérité de SqlSmoObject.)
Méthode protégée BindDefaultImpl Lie les éléments par défaut identifiés par les paramètres. (hérité de SqlSmoObject.)
Méthode protégée BindRuleImpl Lie le schéma de règle à la règle et aux colonnes identifiées par les paramètres. (hérité de SqlSmoObject.)
Méthode protégée CheckCollation Vérifie l'ordre des options de script par la méthode de classement identifiée par le paramètre collationName. (hérité de SqlSmoObject.)
Méthode protégée CheckObjectState() () () () Valide l'état de l'objet référencé. (hérité de SqlSmoObject.)
Méthode protégée CheckObjectState(Boolean) Valide l'état de l'objet référencé avec l'option permettant de spécifier qu'une exception est levée si l'objet n'est pas encore créé. (hérité de SqlSmoObject.)
Méthode protégée CheckObjectStateImpl Vérifie l'état de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion100 Vérifie si la version de SQL Server est SQL Server 2008. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion80 Vérifie la validité de l'objet sur SQL Server 2000. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion80SP3 Vérifie la validité de l'objet sur SQL Server 2000 SP3. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion90 Vérifie la validité de l'objet sur SQL Server 2005. (hérité de SqlSmoObject.)
Méthode protégée CheckVersionBelow90 Vérifie si la version de SQL Server est antérieure à SQL Server 2005. (hérité de SqlSmoObject.)
Méthode protégée CleanObject Définit l'objet sur l'état non modifié. (hérité de SqlSmoObject.)
Méthode publique Create Creates a user-defined message on the instance of SQL Server as defined by the UserDefinedMessage object.
Méthode protégée CreateImpl Crée un objet avec les options de script. (hérité de SqlSmoObject.)
Méthode protégée CreateImplFinish Méthode appelée lorsque l'événement de création est terminé. (hérité de SqlSmoObject.)
Méthode protégée CreateImplInit Méthode appelée lorsque l'événement de création est initialisé. (hérité de SqlSmoObject.)
Méthode publique Discover Découvre une liste de type Object. (hérité de SqlSmoObject.)
Méthode publique Drop Removes the user-defined message from the instance of SQL Server.
Méthode protégée DropImpl Supprime un SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée DropImplWorker Appelle les méthodes de suppression. (hérité de SqlSmoObject.)
Méthode protégée EnumScriptImpl Énumère des scripts spécifiés par le paramètre so. (hérité de SqlSmoObject.)
Méthode protégée EnumScriptImplWorker Appelle les méthodes qui énumèrent des scripts spécifiés par le paramètre so. (hérité de SqlSmoObject.)
Méthode protégée EnumScriptImplWorkerSOChanged Retourne une chaîne IEnumerable qui décrit les options de script pour un objet. (hérité de SqlSmoObject.)
Méthode publique Equals (hérité de Object.)
Méthode protégée ExecuteNonQuery (hérité de SqlSmoObject.)
Méthode protégée Finalize (hérité de Object.)
Méthode protégée FormatSqlVariant Met en forme un objet en tant que type SqlVariant. (hérité de SqlSmoObject.)
Méthode protégée GenerateDataSpaceFileStreamScript Génère un script pour créer un fichier de données. (hérité de SqlSmoObject.)
Méthode protégée GenerateDataSpaceScript Génère un script pour allouer l'espace dans le fichier de données. (hérité de SqlSmoObject.)
Méthode protégée GetBindDefaultScript Obtient le script qui lie les valeurs par défaut spécifiées par les paramètres defName et defSchema. (hérité de SqlSmoObject.)
Méthode protégée GetBindRuleScript Obtient le script qui spécifie les règles de liaison. (hérité de SqlSmoObject.)
Méthode protégée GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Affecte un paramètre booléen du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Affecte une propriété booléenne du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetDateTimeParameter Affecte une propriété datetime du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetDateTimeParameterAsInt Affecte la propriété datetime du SqlSmoObject comme une valeur entière, si la propriété datetime n'est pas Null. (hérité de SqlSmoObject.)
Méthode protégée GetDBName Obtient le nom de la base de données associée à l'objet. (hérité de SqlSmoObject.)
Méthode protégée GetEnumParameter Affecte une propriété d'énumération du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetFragOptionString Obtient un objet FragmentationOption en tant que valeur de chaîne. (hérité de SqlSmoObject.)
Méthode protégée GetGuidParameter Affecte une propriété Guid du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique GetHashCode (hérité de Object.)
Méthode protégée GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Affecte un paramètre du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Affecte un paramètre du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetPropValue Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetPropValueOptional Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetPropValueOptionalAllowNull Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetRealValue Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetScriptingOptionsForCreate Obtient ScriptingOptions pour l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetServerName Obtient le nom de l'instance de SQL Server à laquelle l'objet est associé. (hérité de SqlSmoObject.)
Méthode protégée GetServerObject Obtient le serveur de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetSqlServerVersionName Obtient le nom de version de l'instance de SQL Server à laquelle l'objet est associé. (hérité de SqlSmoObject.)
Méthode protégée GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Affecte un paramètre de chaîne de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Affecte un paramètre de chaîne de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetTimeSpanParameterAsInt Affecte un paramètre d'intervalle de temps de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique GetType (hérité de Object.)
Méthode protégée GetUrnRecursive(StringBuilder) Affecte un objet Urn de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetUrnRecursive(StringBuilder, UrnIdOption) Affecte un objet Urn de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ImplInitialize Initialise les champs de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique Initialize() () () () Initialise l'objet et force le chargement des propriétés. (hérité de SqlSmoObject.)
Méthode publique Initialize(Boolean) Initialise l'objet et force le chargement des propriétés. (hérité de SqlSmoObject.)
Méthode protégée IsObjectDirty Vérifie si les propriétés de l'objet ont été modifiées et si les modifications n'ont pas encore été rendues persistantes sur l'instance de SQL Server. (hérité de SqlSmoObject.)
Méthode protégée IsObjectInitialized Vérifie si l'objet a été initialisé. (hérité de SqlSmoObject.)
Méthode protégée IsObjectInSpace Vérifie si l'objet est isolé ou connecté à l'instance de SQL Server. (hérité de SqlSmoObject.)
Méthode protégée IsVersion80SP3 Détermine si la version de SQL Server est SQL Server 2000 avec SP3. (hérité de SqlSmoObject.)
Méthode protégée IsVersion90AndAbove Détermine si la version de SQL Server est SQL Server 2005 ou une version ultérieure. (hérité de SqlSmoObject.)
Méthode protégée MarkDropped Définit l'objet SqlSmoState à supprimer. (hérité de SqlSmoObject.)
Méthode protégée MarkForDropImpl Définit l'objet SqlSmoState à supprimer. (hérité de SqlSmoObject.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode protégée PostAlter Méthode activée après la modification du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée PostCreate Méthode activée après la création du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée PostDrop Méthode activée après la suppression du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique Refresh Actualise l'objet et récupère les propriétés lors du prochain accès à l'objet. (hérité de SqlSmoObject.)
Méthode publique Script() () () () Generates a Transact-SQL script that can be used to re-create the user-defined message.
Méthode publique Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined message as specified by the script options.
Méthode protégée ScriptAlter Modifie l'objet SqlSmoObject d'après les paramètres. (hérité de SqlSmoObject.)
Méthode protégée ScriptCreate Modifie l'objet SqlSmoObject d'après les paramètres. (hérité de SqlSmoObject.)
Méthode protégée ScriptDdl Lève une exception InvalidSmoOperationException. (hérité de SqlSmoObject.)
Méthode protégée ScriptDrop Lève une exception InvalidSmoOperationException. (hérité de SqlSmoObject.)
Méthode protégée ScriptImpl() () () () Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ScriptImpl(ScriptingOptions) Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ScriptImplWorker Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée SetParentImpl Définit le parent du SqlSmoObject sur le paramètre newParent. (hérité de SqlSmoObject.)
Méthode publique ToString Retourne un String qui représente l'objet référencé. (hérité de SqlSmoObject.)
Méthode protégée TouchImpl Non implémenté. (hérité de SqlSmoObject.)
Méthode protégée UnbindDefaultImpl Annule la liaison des colonnes par défaut du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée UnbindRuleImpl Annule la liaison des règles du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique Validate Validates the state of an object. (hérité de SmoObjectBase.)

Haut de la page

Événements

  Nom Description
Événement public PropertyChanged Représente l'événement qui se produit lorsqu'une propriété est modifiée. (hérité de SqlSmoObject.)
Événement public PropertyMetadataChanged Représente l'événement qui se produit lorsque les métadonnées de la propriété sont modifiées. (hérité de SqlSmoObject.)

Haut de la page

Champs

  Nom Description
Champ protégé m_ExtendedProperties Représente une propriété définie pour étendre les propriétés fournies par un SqlSmoObject. (hérité de SqlSmoObject.)
Champ protégé singletonParent Représente le parent de singleton. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .Discover Découvre les éventuelles dépendances. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetDomainRoot Retourne la racine du domaine. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetParent Obtient le parent de cet objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetPropertyType Obtient le type de la propriété spécifiée. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetPropertyValue Obtient la valeur de la propriété spécifiée. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetUrn Obtient l'URN (Uniform Resource Name) de l'objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .Resolve Obtient l'instance qui contient les informations relatives à l'objet de l'URN (Unified Resource Name) de l'objet. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .SetObjectState Définit l'état de l'objet sur la valeur SfcObjectState spécifiée. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .SetPropertyValue Définit la valeur de la propriété. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée ISfcPropertyProvider. . :: . .GetPropertySet Obtient la référence d'interface au jeu de propriétés de cet objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)

Haut de la page

Notes

The UserDefinedMessage object represents messages that have been defined by the user and SystemMessage object represents messages that are already defined by the system.

To get or set UserDefinedMessage object properties, users can be a member of the public fixed server role.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.