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 名前空間

その他の技術情報

メッセージの使用