UserDefinedMessage 类

The UserDefinedMessage object represents a user-defined message.

继承层次结构

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
    Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
      Microsoft.SqlServer.Management.Smo. . :: . .MessageObjectBase
        Microsoft.SqlServer.Management.Smo..::..UserDefinedMessage

命名空间：  Microsoft.SqlServer.Management.Smo
程序集：  Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
Public NotInheritable Class UserDefinedMessage _
    Inherits MessageObjectBase _
    Implements ICreatable, IDroppable, IAlterable, IScriptable
用法
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

UserDefinedMessage 类型公开以下成员。

构造函数

	名称	说明
	UserDefinedMessage() () () ()	Initializes a new instance of the UserDefinedMessage class.
	UserDefinedMessage(Server, Int32)	Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server and with the specified ID value.
	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.
	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.
	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.
	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.
	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.

页首

属性

	名称	说明
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. （从 SqlSmoObject 继承。）
	ID	Gets the ID value that uniquely identifies the user-defined message.
	IsLogged	Gets or sets the Boolean property value that specifies whether the message is logged to the Microsoft Windows event log.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. （从 SqlSmoObject 继承。）
	Language	Gets or sets the language in which the message is written.
	LanguageID	Gets or sets the ID value that uniquely identifies the language in which the message is written.
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	Parent	Gets the Server object that specifies the parent of the UserDefinedMessage object.
	Properties	Gets a collection of Property objects that represent the object properties. （从 SqlSmoObject 继承。）
	ScalarResult	Gets the scalar result for the referenced object. （从 SqlSmoObject 继承。）
	Severity	Gets or sets the severity of the user-defined message.
	State	Gets the state of the referenced object. （从 SmoObjectBase 继承。）
	Text	Gets or sets the textual description of the user-defined message.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. （从 SqlSmoObject 继承。）
	UserData	Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）

页首

方法

	名称	说明
	AddDatabaseContext	（从 SqlSmoObject 继承。）
	Alter	Updates any UserDefinedMessage object property changes on the instance of SQL Server.
	AlterImpl	（从 SqlSmoObject 继承。）
	AlterImplFinish	（从 SqlSmoObject 继承。）
	AlterImplInit	（从 SqlSmoObject 继承。）
	AlterImplWorker	（从 SqlSmoObject 继承。）
	BindDefaultImpl	（从 SqlSmoObject 继承。）
	BindRuleImpl	（从 SqlSmoObject 继承。）
	CheckCollation	（从 SqlSmoObject 继承。）
	CheckObjectState() () () ()	Validates the state of the referenced object. （从 SqlSmoObject 继承。）
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. （从 SqlSmoObject 继承。）
	CheckObjectStateImpl	（从 SqlSmoObject 继承。）
	CheckVersion100	（从 SqlSmoObject 继承。）
	CheckVersion80	Checks the validity of the object on SQL Server 2000. （从 SqlSmoObject 继承。）
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. （从 SqlSmoObject 继承。）
	CheckVersion90	Check the validity of the object on SQL Server 2005. （从 SqlSmoObject 继承。）
	CheckVersionBelow90	（从 SqlSmoObject 继承。）
	CleanObject	（从 SqlSmoObject 继承。）
	Create	Creates a user-defined message on the instance of SQL Server as defined by the UserDefinedMessage object.
	CreateImpl	（从 SqlSmoObject 继承。）
	CreateImplFinish	（从 SqlSmoObject 继承。）
	CreateImplInit	（从 SqlSmoObject 继承。）
	Discover	（从 SqlSmoObject 继承。）
	Drop	Removes the user-defined message from the instance of SQL Server.
	DropImpl	（从 SqlSmoObject 继承。）
	DropImplWorker	（从 SqlSmoObject 继承。）
	EnumScriptImpl	（从 SqlSmoObject 继承。）
	EnumScriptImplWorker	（从 SqlSmoObject 继承。）
	Equals	（从 Object 继承。）
	Finalize	（从 Object 继承。）
	FormatSqlVariant	（从 SqlSmoObject 继承。）
	GenerateDataSpaceFileStreamScript	（从 SqlSmoObject 继承。）
	GenerateDataSpaceScript	（从 SqlSmoObject 继承。）
	GetBindDefaultScript	（从 SqlSmoObject 继承。）
	GetBindRuleScript	（从 SqlSmoObject 继承。）
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetDateTimeParameter	（从 SqlSmoObject 继承。）
	GetDateTimeParameterAsInt	（从 SqlSmoObject 继承。）
	GetDBName	Gets the database name that is associated with the object. （从 SqlSmoObject 继承。）
	GetEnumParameter	（从 SqlSmoObject 继承。）
	GetFragOptionString	（从 SqlSmoObject 继承。）
	GetGuidParameter	（从 SqlSmoObject 继承。）
	GetHashCode	（从 Object 继承。）
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetPropValue	（从 SqlSmoObject 继承。）
	GetPropValueOptional	（从 SqlSmoObject 继承。）
	GetPropValueOptionalAllowNull	（从 SqlSmoObject 继承。）
	GetRealValue	（从 SqlSmoObject 继承。）
	GetScriptingOptionsForCreate	（从 SqlSmoObject 继承。）
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetServerObject	（从 SqlSmoObject 继承。）
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	（从 SqlSmoObject 继承。）
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	（从 SqlSmoObject 继承。）
	GetTimeSpanParameterAsInt	（从 SqlSmoObject 继承。）
	GetType	（从 Object 继承。）
	GetUrnRecursive(StringBuilder)	（从 SqlSmoObject 继承。）
	GetUrnRecursive(StringBuilder, UrnIdOption)	（从 SqlSmoObject 继承。）
	ImplInitialize	（从 SqlSmoObject 继承。）
	Initialize() () () ()	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	IsObjectDirty	Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. （从 SqlSmoObject 继承。）
	IsObjectInitialized	Verifies whether the object has been initialized. （从 SqlSmoObject 继承。）
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	IsVersion80SP3	（从 SqlSmoObject 继承。）
	MarkDropped	（从 SqlSmoObject 继承。）
	MarkForDropImpl	（从 SqlSmoObject 继承。）
	MemberwiseClone	（从 Object 继承。）
	PostAlter	（从 SqlSmoObject 继承。）
	PostCreate	（从 SqlSmoObject 继承。）
	PostDrop	（从 SqlSmoObject 继承。）
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. （从 SqlSmoObject 继承。）
	Script() () () ()	Generates a Transact-SQL script that can be used to re-create the user-defined message.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the user-defined message as specified by the script options.
	ScriptAlter	（从 SqlSmoObject 继承。）
	ScriptCreate	（从 SqlSmoObject 继承。）
	ScriptDdl	（从 SqlSmoObject 继承。）
	ScriptDrop	（从 SqlSmoObject 继承。）
	ScriptImpl() () () ()	（从 SqlSmoObject 继承。）
	ScriptImpl(ScriptingOptions)	（从 SqlSmoObject 继承。）
	ScriptImplWorker	（从 SqlSmoObject 继承。）
	SetParentImpl	（从 SqlSmoObject 继承。）
	ToString	Returns a String that represents the referenced object. （从 SqlSmoObject 继承。）
	TouchImpl	（从 SqlSmoObject 继承。）
	UnbindDefaultImpl	（从 SqlSmoObject 继承。）
	UnbindRuleImpl	（从 SqlSmoObject 继承。）
	Validate	（从 SmoObjectBase 继承。）

页首

事件

	名称	说明
	PropertyChanged	（从 SqlSmoObject 继承。）
	PropertyMetadataChanged	（从 SqlSmoObject 继承。）

页首

字段

	名称	说明
	m_ExtendedProperties	（从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObjectDiscover	（从 SqlSmoObject 继承。）
	IAlienObjectGetParent	（从 SqlSmoObject 继承。）
	IAlienObjectGetProperty	（从 SqlSmoObject 继承。）
	ISfcPropertyProviderGetPropertySet	（从 SqlSmoObject 继承。）
	IAlienObjectGetUrn	（从 SqlSmoObject 继承。）
	IAlienObjectResolve	（从 SqlSmoObject 继承。）
	IAlienObjectSetProperty	（从 SqlSmoObject 继承。）

页首

注释

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.

示例

使用消息

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo 命名空间

其他资源

使用消息