UserDefinedMessage クラス
UserDefinedMessage オブジェクトは、ユーザー定義メッセージを表します。
継承階層
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() | UserDefinedMessage クラスの新しいインスタンスを初期化します。 | |
UserDefinedMessage(Server, Int32) | 指定した SQL Server のインスタンスで、指定した ID 値を使用して UserDefinedMessage クラスの新しいインスタンスを初期化します。 | |
UserDefinedMessage(Server, Int32, String) | 指定した SQL Server のインスタンスで、指定した ID 値を使用して、指定した言語で記述された UserDefinedMessage クラスの新しいインスタンスを初期化します。 | |
UserDefinedMessage(Server, Int32, Int32, Int32, String) | 指定した SQL Server のインスタンスで、指定した ID 値を使用して、指定した言語、指定した重大度、および実際のメッセージ テキストで記述された UserDefinedMessage クラスの新しいインスタンスを初期化します。 | |
UserDefinedMessage(Server, Int32, String, Int32, String) | 指定した SQL Server のインスタンスで、指定した ID 値を使用して、指定した言語、指定した重大度、および実際のメッセージ テキストで記述された UserDefinedMessage クラスの新しいインスタンスを初期化します。 | |
UserDefinedMessage(Server, Int32, Int32, Int32, String, Boolean) | 指定した SQL Server のインスタンスで、指定した ID 値を使用して、指定した言語、指定した重大度、実際のメッセージ テキストで記述され、メッセージを Windows イベント ログに記録するかどうかを指定するオプションを持つ UserDefinedMessage クラスの新しいインスタンスを初期化します。 | |
UserDefinedMessage(Server, Int32, String, Int32, String, Boolean) | 指定した SQL Server のインスタンスで、指定した ID 値を使用して、指定した言語、指定した重大度、実際のメッセージ テキストで記述され、メッセージを Windows イベント ログに記録するかどうかを指定するオプションを持つ UserDefinedMessage クラスの新しいインスタンスを初期化します。 |
先頭に戻る
プロパティ
名前 | 説明 | |
---|---|---|
ID | ユーザー定義メッセージを一意に識別する ID 値を取得します。 | |
IsLogged | メッセージを Microsoft Windows イベント ログに記録するかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 | |
Language | メッセージを記述する言語を取得します。値の設定も可能です。 | |
LanguageID | メッセージを記述する言語を一意に識別する ID 値を取得します。値の設定も可能です。 | |
Parent | UserDefinedMessage オブジェクトの親を示す Server オブジェクトを取得します。 | |
Properties | オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。) | |
Severity | ユーザー定義メッセージの重大度を取得します。値の設定も可能です。 | |
State | 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。) | |
Text | ユーザー定義メッセージの説明テキストを取得します。値の設定も可能です。 | |
Urn | オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。) | |
UserData | 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。) |
先頭に戻る
メソッド
名前 | 説明 | |
---|---|---|
Alter | SQL Server のインスタンスの UserDefinedMessage オブジェクトのプロパティに対する変更をすべて更新します。 | |
Create | SQL Server のインスタンスで、UserDefinedMessage オブジェクトによる定義に基づいてユーザー定義メッセージを作成します。 | |
Discover | Object 型の一覧を検出します。 (SqlSmoObject から継承されています。) | |
Drop | SQL Server のインスタンスからユーザー定義メッセージを削除します。 | |
Equals | (Object から継承されています。) | |
FormatSqlVariant | SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。) | |
GetContextDB | このオブジェクトに関連付けられているコンテキスト データベースを取得します。 (SqlSmoObject から継承されています。) | |
GetDBName | オブジェクトに関連付けられたデータベース名を取得します。 (SqlSmoObject から継承されています。) | |
GetHashCode | (Object から継承されています。) | |
GetPropValue | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
GetPropValueOptional | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
GetPropValueOptionalAllowNull | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
GetServerObject | SqlSmoObject オブジェクトのサーバーを取得します。 (SqlSmoObject から継承されています。) | |
GetType | (Object から継承されています。) | |
Initialize() | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) | |
Initialize(Boolean) | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) | |
IsObjectInitialized | オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。) | |
IsObjectInSpace | オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。) | |
Refresh | オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。) | |
Script() | ユーザー定義メッセージの再作成に使用できる Transact-SQL スクリプトを生成します。 | |
Script(ScriptingOptions) | スクリプト オプションで指定したとおりにユーザー定義メッセージを再作成するために使用できる Transact-SQL スクリプトを生成します。 | |
SetParentImpl | SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。) | |
ToString | 参照するオブジェクトを表す String を返します。 (SqlSmoObject から継承されています。) | |
Validate | オブジェクトの状態を検証します。 (SmoObjectBase から継承されています。) |
先頭に戻る
イベント
名前 | 説明 | |
---|---|---|
PropertyChanged | プロパティが変更されるときに発生するイベントを表します。 (SqlSmoObject から継承されています。) | |
PropertyMetadataChanged | プロパティ メタデータが変更されたときに発生するイベントを表します。 (SqlSmoObject から継承されています。) |
先頭に戻る
明示的なインターフェイスの実装
名前 | 説明 | |
---|---|---|
IAlienObject.Discover | 依存関係を検出します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetDomainRoot | ドメインのルートを返します。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetParent | このオブジェクトの親を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetPropertyType | 指定したプロパティの種類を取得します。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetPropertyValue | 指定されたプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetUrn | オブジェクトの Unified Resource Name (URN) を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) | |
IAlienObject.Resolve | オブジェクトに関する情報を含むインスタンスを、オブジェクトの Unified Resource Name (URN) から取得します。 (SqlSmoObject から継承されています。) | |
IAlienObject.SetObjectState | オブジェクトの状態を、指定した SfcObjectState 値に設定します。 (SqlSmoObject から継承されています。) | |
IAlienObject.SetPropertyValue | プロパティの値を設定します。 (SqlSmoObject から継承されています。) | |
ISfcPropertyProvider.GetPropertySet | このオブジェクトのプロパティ セットへのインターフェイス リファレンスを取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
先頭に戻る
説明
UserDefinedMessage オブジェクトは、ユーザーによって定義されたメッセージを表します。SystemMessage オブジェクトは、システムによってあらかじめ定義されているメッセージを表します。
UserDefinedMessage オブジェクトのプロパティを取得または設定するには、固定サーバー ロール public のメンバーでもかまいません。
使用例
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Smo 名前空間