Any suggestions? Export (0) Print
Expand All

UserDefinedMessage Class

 

The UserDefinedMessage object represents a user-defined message.

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


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

NameDescription
System_CAPS_pubmethodUserDefinedMessage()

Initializes a new instance of the UserDefinedMessage class.

System_CAPS_pubmethodUserDefinedMessage(Server, Int32)

Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server and with the specified ID value.

System_CAPS_pubmethodUserDefinedMessage(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.

System_CAPS_pubmethodUserDefinedMessage(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.

System_CAPS_pubmethodUserDefinedMessage(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.

System_CAPS_pubmethodUserDefinedMessage(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.

System_CAPS_pubmethodUserDefinedMessage(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.

NameDescription
System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the user-defined message.

System_CAPS_pubpropertyIsLogged

Gets or sets the Boolean property value that specifies whether the message is logged to the Microsoft Windows event log.

System_CAPS_pubpropertyLanguage

Gets or sets the language in which the message is written.

System_CAPS_pubpropertyLanguageID

Gets or sets the ID value that uniquely identifies the language in which the message is written.

System_CAPS_pubpropertyParent

Gets the Server object that specifies the parent of the UserDefinedMessage object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySeverity

Gets or sets the severity of the user-defined message.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyText

Gets or sets the textual description of the user-defined message.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any UserDefinedMessage object property changes on the instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates a user-defined message on the instance of SQL Server as defined by the UserDefinedMessage object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the user-defined message from the instance of SQL Server.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the user-defined message.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the user-defined message as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft