Freigeben über

  • Artikel

UserDefinedMessage-Klasse

The UserDefinedMessage object represents a user-defined message.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class UserDefinedMessage _
    Inherits MessageObjectBase _
    Implements ICreatable, IDroppable, IAlterable, IScriptable
'Usage
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

Der UserDefinedMessage-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode UserDefinedMessage() () () () Initializes a new instance of the UserDefinedMessage class.
Öffentliche Methode UserDefinedMessage(Server, Int32) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server and with the specified ID value.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.
Öffentliche Methode 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.

Zum Anfang

Eigenschaften

  Name Beschreibung
Geschützte Eigenschaft ExecuteForScalar Ruft den Boolean-Eigenschaftswert ab, der angibt, ob das Objekt auf die ExecuteForScalar-Option festgelegt ist, oder legt ihn fest. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft ID Gets the ID value that uniquely identifies the user-defined message.
Öffentliche Eigenschaft IsLogged Gets or sets the Boolean property value that specifies whether the message is logged to the Microsoft Windows event log.
Geschützte Eigenschaft IsTouched Ruft den Boolean-Eigenschaftswert ab, der angibt, ob die Objekteigenschaften aktualisiert, aber noch nicht permanent auf dem Server gespeichert wurden. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft Language Gets or sets the language in which the message is written.
Öffentliche Eigenschaft LanguageID Gets or sets the ID value that uniquely identifies the language in which the message is written.
Geschützte Eigenschaft ObjectInSpace Ruft den Boolean-Eigenschaftswert ab, der angibt, ob das Objekt isoliert vorhanden bzw. direkt oder indirekt mit der SQL Server-Instanz verbunden ist. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft Parent Gets the Server object that specifies the parent of the UserDefinedMessage object.
Öffentliche Eigenschaft Properties Ruft eine Auflistung von Property-Objekten ab, die die Objekteigenschaften darstellen. (Geerbt von SqlSmoObject.)
Geschützte Eigenschaft ScalarResult Ruft das skalare Ergebnis für das Objekt ab, auf das verwiesen wird. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft Severity Gets or sets the severity of the user-defined message.
Öffentliche Eigenschaft State Gets the state of the referenced object. (Geerbt von SmoObjectBase.)
Öffentliche Eigenschaft Text Gets or sets the textual description of the user-defined message.
Öffentliche Eigenschaft Urn Ruft den Wert der URN (Uniform Resource Name)-Adresse ab, durch den das Objekt eindeutig identifiziert wird. (Geerbt von SqlSmoObject.)
Öffentliche Eigenschaft UserData Gets or sets user-defined data associated with the referenced object. (Geerbt von SmoObjectBase.)

Zum Anfang

Methoden

  Name Beschreibung
Geschützte Methode AddDatabaseContext(StringCollection) Fügt der Auflistung der vom queries-Parameter identifizierten Abfragen den Datenbankkontext hinzu. (Geerbt von SqlSmoObject.)
Geschützte Methode AddDatabaseContext(StringCollection, ScriptingOptions) Fügt der Auflistung der vom queries-Parameter identifizierten Abfragen den Datenbankkontext gemäß den angegebenen Skriptoptionen hinzu. (Geerbt von SqlSmoObject.)
Öffentliche Methode Alter Updates any UserDefinedMessage object property changes on the instance of SQL Server. 
Geschützte Methode AlterImpl Aktiviert das Änderungsereignis des Objekts. (Geerbt von SqlSmoObject.)
Geschützte Methode AlterImplFinish Die Methode, die nach Beendigung des Änderungsereignisses des Objekts aufgerufen wird. (Geerbt von SqlSmoObject.)
Geschützte Methode AlterImplInit Die Methode, die bei der Initialisierung des Änderungsereignisses des Objekts aufgerufen wird. (Geerbt von SqlSmoObject.)
Geschützte Methode AlterImplWorker Ruft die ALTER-Methoden auf. (Geerbt von SqlSmoObject.)
Geschützte Methode BindDefaultImpl Bindet die von den Parametern identifizierten Standardelemente. (Geerbt von SqlSmoObject.)
Geschützte Methode BindRuleImpl Bindet das Regelschema an die Regel und die Spalten, die von den Parametern identifiziert werden. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckCollation Überprüft die Reihenfolge der Skriptoptionen anhand der vom collationName-Parameter identifizierten Sortierungsmethode. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckObjectState() () () () Überprüft den Status des Objekts, auf das verwiesen wird. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckObjectState(Boolean) Überprüft den Status des Objekts, auf das verwiesen wird. Optional kann angegeben werden, dass eine Ausnahme ausgelöst wird, wenn das Objekt noch nicht erstellt wurde. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckObjectStateImpl Überprüft den Zustand von SqlSmoObject. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckVersion100 Überprüft, ob die SQL Server-Version SQL Server 2008 ist. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckVersion80 Überprüft die Gültigkeit des Objekts für SQL Server 2000. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckVersion80SP3 Überprüft die Gültigkeit des Objekts für SQL Server 2000 SP3. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckVersion90 Überprüft die Gültigkeit des Objekts für SQL Server 2005. (Geerbt von SqlSmoObject.)
Geschützte Methode CheckVersionBelow90 Überprüft, ob die SQL Server-Version älter als SQL Server 2005 ist. (Geerbt von SqlSmoObject.)
Geschützte Methode CleanObject Legt für das Objekt den unveränderten Zustand fest. (Geerbt von SqlSmoObject.)
Öffentliche Methode Create Creates a user-defined message on the instance of SQL Server as defined by the UserDefinedMessage object.
Geschützte Methode CreateImpl Erstellt ein Objekt mit Skriptoptionen. (Geerbt von SqlSmoObject.)
Geschützte Methode CreateImplFinish Die Methode, die nach Beendigung des CREATE-Ereignisses aufgerufen wird. (Geerbt von SqlSmoObject.)
Geschützte Methode CreateImplInit Die Methode, die bei Initialisierung des CREATE-Ereignisses aufgerufen wird. (Geerbt von SqlSmoObject.)
Öffentliche Methode Discover Ermittelt eine Liste vom Typ Object. (Geerbt von SqlSmoObject.)
Öffentliche Methode Drop Removes the user-defined message from the instance of SQL Server.
Geschützte Methode DropImpl Löscht SqlSmoObject. (Geerbt von SqlSmoObject.)
Geschützte Methode DropImplWorker Ruft die DROP-Methoden auf. (Geerbt von SqlSmoObject.)
Geschützte Methode EnumScriptImpl Listet die vom so-Parameter angegebenen Skripts auf. (Geerbt von SqlSmoObject.)
Geschützte Methode EnumScriptImplWorker Ruft die Methoden auf, die die vom so-Parameter angegebenen Skripts auflisten. (Geerbt von SqlSmoObject.)
Geschützte Methode EnumScriptImplWorkerSOChanged Gibt eine IEnumerable-Zeichenfolge zurück, die die Skriptoptionen für ein Objekt beschreibt. (Geerbt von SqlSmoObject.)
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode ExecuteNonQuery (Geerbt von SqlSmoObject.)
Geschützte Methode Finalize (Geerbt von Object.)
Geschützte Methode FormatSqlVariant Formatiert ein Objekt als SqlVariant-Typ. (Geerbt von SqlSmoObject.)
Geschützte Methode GenerateDataSpaceFileStreamScript Generiert ein Skript zum Erstellen der Datendatei. (Geerbt von SqlSmoObject.)
Geschützte Methode GenerateDataSpaceScript Generiert ein Skript zum Zuordnen von Speicherplatz in der Datendatei. (Geerbt von SqlSmoObject.)
Geschützte Methode GetBindDefaultScript Ruft das Skript ab, durch das die vom defSchema-Parameter und defName-Parameter angegebenen Standardwerte gebunden werden. (Geerbt von SqlSmoObject.)
Geschützte Methode GetBindRuleScript Ruft das Skript ab, das die Bindungsregeln angibt. (Geerbt von SqlSmoObject.)
Geschützte Methode GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Weist einen booleschen Parameter von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Weist eine boolesche Eigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetDateTimeParameter Weist die datetime-Eigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetDateTimeParameterAsInt Weist die datetime-Eigenschaft von SqlSmoObject als ganzzahligen Wert zu, wenn die datetime-Eigenschaft nicht NULL ist. (Geerbt von SqlSmoObject.)
Geschützte Methode GetDBName Ruft den Datenbanknamen ab, der dem Objekt zugeordnet ist. (Geerbt von SqlSmoObject.)
Geschützte Methode GetEnumParameter Weist die Enumerationseigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetFragOptionString Ruft ein FragmentationOption-Objekt als Zeichenfolgenwert ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetGuidParameter Weist eine Guid-Eigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Geschützte Methode GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Weist einen Parameter von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Weist einen Parameter von SqlSmoObject zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetPropValue Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetPropValueOptional Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetPropValueOptionalAllowNull Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetRealValue Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetScriptingOptionsForCreate Ruft ScriptingOptions für das SqlSmoObject-Objekt ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetServerName Ruft den Namen der SQL Server-Instanz ab, der das Objekt zugeordnet ist. (Geerbt von SqlSmoObject.)
Geschützte Methode GetServerObject Ruft den Server des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.)
Geschützte Methode GetSqlServerVersionName Ruft den Versionsnamen der SQL Server-Instanz ab, der das Objekt zugeordnet ist. (Geerbt von SqlSmoObject.)
Geschützte Methode GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Weist einen Zeichenfolgenparameter des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Weist einen Zeichenfolgenparameter des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetTimeSpanParameterAsInt Weist einen Zeitraumparameter des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.)
Öffentliche Methode GetType (Geerbt von Object.)
Geschützte Methode GetUrnRecursive(StringBuilder) Weist ein Urn-Objekt des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.)
Geschützte Methode GetUrnRecursive(StringBuilder, UrnIdOption) Weist ein Urn-Objekt des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.)
Geschützte Methode ImplInitialize Initialisiert die Felder des SqlSmoObject-Objekts. (Geerbt von SqlSmoObject.)
Öffentliche Methode Initialize() () () () Initialisiert das Objekt und erzwingt das Laden der Eigenschaften. (Geerbt von SqlSmoObject.)
Öffentliche Methode Initialize(Boolean) Initialisiert das Objekt und erzwingt das Laden der Eigenschaften. (Geerbt von SqlSmoObject.)
Geschützte Methode IsObjectDirty Überprüft, ob die Objekteigenschaften geändert und die Änderungen noch nicht permanent für die SQL Server-Instanz gespeichert wurden. (Geerbt von SqlSmoObject.)
Geschützte Methode IsObjectInitialized Überprüft, ob das Objekt initialisiert wurde. (Geerbt von SqlSmoObject.)
Geschützte Methode IsObjectInSpace Überprüft, ob das Objekt isoliert vorhanden oder mit der SQL Server-Instanz verbunden ist. (Geerbt von SqlSmoObject.)
Geschützte Methode IsVersion80SP3 Ermittelt, ob die SQL Server-Version SQL Server 2000 mit SP3 ist. (Geerbt von SqlSmoObject.)
Geschützte Methode IsVersion90AndAbove Ermittelt, ob die SQL Server-Version SQL Server 2005 oder höher ist. (Geerbt von SqlSmoObject.)
Geschützte Methode MarkDropped Legt den zu löschenden SqlSmoState fest. (Geerbt von SqlSmoObject.)
Geschützte Methode MarkForDropImpl Legt den zu löschenden SqlSmoState fest. (Geerbt von SqlSmoObject.)
Geschützte Methode MemberwiseClone (Geerbt von Object.)
Geschützte Methode PostAlter Die Methode, die nach dem Ändern von SqlSmoObject aktiviert wird. (Geerbt von SqlSmoObject.)
Geschützte Methode PostCreate Die Methode, die nach dem Erstellen von SqlSmoObject aktiviert wird. (Geerbt von SqlSmoObject.)
Geschützte Methode PostDrop Die Methode, die nach dem Löschen von SqlSmoObject aktiviert wird. (Geerbt von SqlSmoObject.)
Öffentliche Methode Refresh Aktualisiert das Objekt und ruft beim nächsten Zugriff auf das Objekt Eigenschaften ab. (Geerbt von SqlSmoObject.)
Öffentliche Methode Script() () () () Generates a Transact-SQL script that can be used to re-create the user-defined message.
Öffentliche Methode Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined message as specified by the script options.
Geschützte Methode ScriptAlter Ändert SqlSmoObject gemäß den Parametern. (Geerbt von SqlSmoObject.)
Geschützte Methode ScriptCreate Ändert SqlSmoObject gemäß den Parametern. (Geerbt von SqlSmoObject.)
Geschützte Methode ScriptDdl Löst InvalidSmoOperationException aus. (Geerbt von SqlSmoObject.)
Geschützte Methode ScriptDrop Löst InvalidSmoOperationException aus. (Geerbt von SqlSmoObject.)
Geschützte Methode ScriptImpl() () () () Ruft eine Skriptauflistung von SqlSmoObject ab. (Geerbt von SqlSmoObject.)
Geschützte Methode ScriptImpl(ScriptingOptions) Ruft eine Skriptauflistung von SqlSmoObject ab. (Geerbt von SqlSmoObject.)
Geschützte Methode ScriptImplWorker Ruft eine Skriptauflistung von SqlSmoObject ab. (Geerbt von SqlSmoObject.)
Geschützte Methode SetParentImpl Legt das übergeordnete Element von SqlSmoObject auf den newParent-Parameter fest. (Geerbt von SqlSmoObject.)
Öffentliche Methode ToString Gibt eine String zurück, die das Objekt darstellt, auf das verwiesen wird. (Geerbt von SqlSmoObject.)
Geschützte Methode TouchImpl Nicht implementiert. (Geerbt von SqlSmoObject.)
Geschützte Methode UnbindDefaultImpl Hebt die Bindung der Standardspalten von SqlSmoObject auf. (Geerbt von SqlSmoObject.)
Geschützte Methode UnbindRuleImpl Hebt die Bindung der Regeln von SqlSmoObject auf. (Geerbt von SqlSmoObject.)
Öffentliche Methode Validate Validates the state of an object. (Geerbt von SmoObjectBase.)

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis PropertyChanged Stellt das Ereignis dar, das bei Änderung einer Eigenschaft auftritt. (Geerbt von SqlSmoObject.)
Öffentliches Ereignis PropertyMetadataChanged Stellt das Ereignis dar, das bei Änderungen an den Eigenschaftsmetadaten auftritt. (Geerbt von SqlSmoObject.)

Zum Anfang

Felder

  Name Beschreibung
Geschütztes Feld m_ExtendedProperties Stellt eine Eigenschaft dar, die zur Erweiterung der von SqlSmoObject bereitgestellten Eigenschaften definiert wird. (Geerbt von SqlSmoObject.)
Geschütztes Feld singletonParent Stellt das übergeordnete Singleton-Element dar. (Geerbt von SqlSmoObject.)

Zum Anfang

Explizite Schnittstellenimplementierungen

  Name Beschreibung
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .Discover Ermittelt alle Abhängigkeiten. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .GetDomainRoot Gibt den Stamm der Domäne zurück. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .GetParent Ruft das übergeordnete Element dieses Objekts ab. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .GetPropertyType Ruft den Typ der angegebenen Eigenschaft ab. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .GetPropertyValue Ruft den Wert der angegebenen Eigenschaft ab. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .GetUrn Ruft den URN (Uniform Resource Name) des Objekts ab. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .Resolve Ruft aus dem URN die Instanz ab, die die Informationen zum Objekt enthält. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .SetObjectState Legt den Objektstatus auf den angegebenen SfcObjectState-Wert fest. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode IAlienObject. . :: . .SetPropertyValue Legt den Eigenschaftswert fest. (Geerbt von SqlSmoObject.)
Explizite SchnittstellenimplementierungPrivate Methode ISfcPropertyProvider. . :: . .GetPropertySet Ruft den Schnittstellenverweis auf den Eigenschaftensatz dieses Objekts ab. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)

Zum Anfang

Hinweise

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.

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.