UserDefinedMessage クラス

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 クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

  名前 説明
プロテクト プロパティ ExecuteForScalar オブジェクトがスカラー オプションの実行に対して設定されるかどうかを示す Boolean プロパティ値を取得または設定します。 (SqlSmoObject から継承されています。)
パブリック プロパティ ID ユーザー定義メッセージを一意に識別する ID 値を取得します。
パブリック プロパティ IsLogged メッセージを Microsoft Windows イベント ログに記録するかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。
プロテクト プロパティ IsTouched オブジェクトのプロパティが更新されていてもサーバーに保存されていないかどうかを示す Boolean プロパティ値を取得します。 (SqlSmoObject から継承されています。)
パブリック プロパティ Language メッセージを記述する言語を取得します。値の設定も可能です。
パブリック プロパティ LanguageID メッセージを記述する言語を一意に識別する ID 値を取得します。値の設定も可能です。
プロテクト プロパティ ObjectInSpace オブジェクトが孤立して存在するか、SQL Server のインスタンスに直接的または間接的に接続されているかを示す Boolean プロパティ値を取得します。 (SqlSmoObject から継承されています。)
パブリック プロパティ Parent UserDefinedMessage オブジェクトの親を示す Server オブジェクトを取得します。
パブリック プロパティ Properties オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。)
プロテクト プロパティ ScalarResult 参照先オブジェクトのスカラー結果を取得します。 (SqlSmoObject から継承されています。)
パブリック プロパティ Severity ユーザー定義メッセージの重大度を取得します。値の設定も可能です。
パブリック プロパティ State 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。)
パブリック プロパティ Text ユーザー定義メッセージの説明テキストを取得します。値の設定も可能です。
パブリック プロパティ Urn オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。)
パブリック プロパティ UserData 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。)

先頭に戻る

メソッド

  名前 説明
プロテクト メソッド AddDatabaseContext(StringCollection) queries パラメーターによって識別されたクエリのコレクションにデータベース コンテキストを追加します。 (SqlSmoObject から継承されています。)
プロテクト メソッド AddDatabaseContext(StringCollection, ScriptingOptions) queries パラメーターによって識別されたクエリのコレクションに、指定したスクリプト作成オプションを使用してデータベース コンテキストを追加します。 (SqlSmoObject から継承されています。)
パブリック メソッド Alter SQL Server のインスタンスの UserDefinedMessage オブジェクトのプロパティに対する変更をすべて更新します。
プロテクト メソッド AlterImpl Object Altered イベントをアクティブにします。 (SqlSmoObject から継承されています。)
プロテクト メソッド AlterImplFinish Object Altered イベントの終了時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。)
プロテクト メソッド AlterImplInit Object-Altered イベントの初期化時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。)
プロテクト メソッド AlterImplWorker Alter メソッドを呼び出します。 (SqlSmoObject から継承されています。)
プロテクト メソッド BindDefaultImpl パラメーターによって識別された既定のアイテムをバインドします。 (SqlSmoObject から継承されています。)
プロテクト メソッド BindRuleImpl パラメーターによって識別されたルールおよび列にルール スキーマをバインドします。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckCollation collationName パラメーターによって識別された Collation メソッドを使用して、スクリプト作成オプションの順序を確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckObjectState() () () () 参照先オブジェクトの状態を検証します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckObjectState(Boolean) 参照先オブジェクトの状態を検証します。オブジェクトがまだ作成されていない場合は、例外をスローするように指定することも可能です。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckObjectStateImpl SqlSmoObject の状態を確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckVersion100 SQL Server のバージョンが SQL Server 2008 かどうかを確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckVersion80 SQL Server 2000 でのオブジェクトの有効性を確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckVersion80SP3 SQL Server 2000 SP3 でのオブジェクトの有効性を確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckVersion90 SQL Server 2005 でのオブジェクトの有効性を確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CheckVersionBelow90 SQL Server のバージョンが SQL Server 2005 より前のバージョンかどうかを確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CleanObject オブジェクトを変更されていない状態に設定します。 (SqlSmoObject から継承されています。)
パブリック メソッド Create SQL Server のインスタンスで、UserDefinedMessage オブジェクトによる定義に基づいてユーザー定義メッセージを作成します。
プロテクト メソッド CreateImpl スクリプト作成オプションを使用してオブジェクトを作成します。 (SqlSmoObject から継承されています。)
プロテクト メソッド CreateImplFinish Create イベントの終了時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。)
プロテクト メソッド CreateImplInit Create イベントによる初期化時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。)
パブリック メソッド Discover Object 型の一覧を検出します。 (SqlSmoObject から継承されています。)
パブリック メソッド Drop SQL Server のインスタンスからユーザー定義メッセージを削除します。
プロテクト メソッド DropImpl SqlSmoObject を削除します。 (SqlSmoObject から継承されています。)
プロテクト メソッド DropImplWorker Drop メソッドを呼び出します。 (SqlSmoObject から継承されています。)
プロテクト メソッド EnumScriptImpl so パラメーターで指定されたスクリプトを列挙します。 (SqlSmoObject から継承されています。)
プロテクト メソッド EnumScriptImplWorker so パラメーターで指定されたスクリプトを列挙するメソッドを呼び出します。 (SqlSmoObject から継承されています。)
プロテクト メソッド EnumScriptImplWorkerSOChanged オブジェクトのスクリプト作成オプションを説明する IEnumerable 文字列を返します。 (SqlSmoObject から継承されています。)
パブリック メソッド Equals (Object から継承されています。)
プロテクト メソッド ExecuteNonQuery 返される結果がないデータベースのコンテキストで、バッチを実行します。 (SqlSmoObject から継承されています。)
プロテクト メソッド Finalize (Object から継承されています。)
プロテクト メソッド FormatSqlVariant SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GenerateDataSpaceFileStreamScript データ ファイルを作成するスクリプトを生成します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GenerateDataSpaceScript データ ファイルに領域を割り当てるスクリプトを生成します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetBindDefaultScript defSchema パラメーターおよび defName パラメーターで指定された既定値をバインドするスクリプトを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetBindRuleScript バインド ルールを示すスクリプトを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) SqlSmoObject のブール型パラメーターを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) SqlSmoObject のブール型プロパティを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetDateTimeParameter SqlSmoObject の日時プロパティを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetDateTimeParameterAsInt 日時プロパティが NULL でない場合、整数値として SqlSmoObject の日時プロパティを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetDBName オブジェクトに関連付けられたデータベース名を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetEnumParameter SqlSmoObject の列挙プロパティを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetFragOptionString FragmentationOption オブジェクトを文字列値として取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetGuidParameter SqlSmoObjectGuid プロパティを割り当てます。 (SqlSmoObject から継承されています。)
パブリック メソッド GetHashCode (Object から継承されています。)
プロテクト メソッド GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) SqlSmoObject のパラメーターを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) SqlSmoObject のパラメーターを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetPropValue SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetPropValueOptional SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetPropValueOptionalAllowNull SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetRealValue SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetScriptingOptionsForCreate SqlSmoObject オブジェクトの ScriptingOptions を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetServerName オブジェクトが関連付けられている SQL Server のインスタンスの名前を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetServerObject SqlSmoObject オブジェクトのサーバーを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetSqlServerVersionName オブジェクトが関連付けられている SQL Server のインスタンスのバージョン名を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) SqlSmoObject オブジェクトの文字列パラメーターを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) SqlSmoObject オブジェクトの文字列パラメーターを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetTimeSpanParameterAsInt SqlSmoObject オブジェクトの期間パラメーターを割り当てます。 (SqlSmoObject から継承されています。)
パブリック メソッド GetType (Object から継承されています。)
プロテクト メソッド GetUrnRecursive(StringBuilder) SqlSmoObject オブジェクトの Urn オブジェクトを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetUrnRecursive(StringBuilder, UrnIdOption) SqlSmoObject オブジェクトの Urn オブジェクトを割り当てます。 (SqlSmoObject から継承されています。)
プロテクト メソッド ImplInitialize SqlSmoObject オブジェクトのフィールドを初期化します。 (SqlSmoObject から継承されています。)
パブリック メソッド Initialize() () () () オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。)
パブリック メソッド Initialize(Boolean) オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsObjectDirty オブジェクトのプロパティが変更されているかどうか、およびその変更が SQL Server のインスタンスにまだ保存されていないかどうかを確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsObjectInitialized オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsObjectInSpace オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsVersion80SP3 SQL Server のバージョンが SQL Server 2000 SP3 かどうかを示します。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsVersion90AndAbove SQL Server のバージョンが SQL Server 2005 以降かどうかを示します。 (SqlSmoObject から継承されています。)
プロテクト メソッド MarkDropped SqlSmoState が削除されるように設定します。 (SqlSmoObject から継承されています。)
プロテクト メソッド MarkForDropImpl SqlSmoState が削除されるように設定します。 (SqlSmoObject から継承されています。)
プロテクト メソッド MemberwiseClone (Object から継承されています。)
プロテクト メソッド PostAlter SqlSmoObject の変更後にアクティブ化されるメソッドです。 (SqlSmoObject から継承されています。)
プロテクト メソッド PostCreate SqlSmoObject の作成後にアクティブ化されるメソッドです。 (SqlSmoObject から継承されています。)
プロテクト メソッド PostDrop SqlSmoObject の削除後にアクティブ化されるメソッドです。 (SqlSmoObject から継承されています。)
パブリック メソッド Refresh オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。)
パブリック メソッド Script() () () () ユーザー定義メッセージの再作成に使用できる Transact-SQL スクリプトを生成します。
パブリック メソッド Script(ScriptingOptions) スクリプト オプションで指定したとおりにユーザー定義メッセージを再作成するために使用できる Transact-SQL スクリプトを生成します。
プロテクト メソッド ScriptAlter パラメーターに従って SqlSmoObject を変更します。 (SqlSmoObject から継承されています。)
プロテクト メソッド ScriptCreate パラメーターに従って SqlSmoObject を変更します。 (SqlSmoObject から継承されています。)
プロテクト メソッド ScriptDdl InvalidSmoOperationException をスローします。 (SqlSmoObject から継承されています。)
プロテクト メソッド ScriptDrop InvalidSmoOperationException をスローします。 (SqlSmoObject から継承されています。)
プロテクト メソッド ScriptImpl() () () () SqlSmoObject のスクリプトのコレクションを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド ScriptImpl(ScriptingOptions) SqlSmoObject のスクリプトのコレクションを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド ScriptImplWorker SqlSmoObject のスクリプトのコレクションを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド SetParentImpl SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。)
パブリック メソッド ToString 参照するオブジェクトを表す String を返します。 (SqlSmoObject から継承されています。)
プロテクト メソッド TouchImpl 未実装です。 (SqlSmoObject から継承されています。)
プロテクト メソッド UnbindDefaultImpl SqlSmoObject の既定の列をバインド解除します。 (SqlSmoObject から継承されています。)
プロテクト メソッド UnbindRuleImpl SqlSmoObject のルールをバインド解除します。 (SqlSmoObject から継承されています。)
パブリック メソッド Validate オブジェクトの状態を検証します。 (SmoObjectBase から継承されています。)

先頭に戻る

イベント

  名前 説明
パブリック イベント PropertyChanged プロパティが変更されるときに発生するイベントを表します。 (SqlSmoObject から継承されています。)
パブリック イベント PropertyMetadataChanged プロパティ メタデータが変更されたときに発生するイベントを表します。 (SqlSmoObject から継承されています。)

先頭に戻る

フィールド

  名前 説明
プロテクト フィールド m_ExtendedProperties SqlSmoObject によって指定されたプロパティを拡張するよう定義されたプロパティを表します。 (SqlSmoObject から継承されています。)
プロテクト フィールド singletonParent 単一の親を表します。 (SqlSmoObject から継承されています。)

先頭に戻る

明示的なインターフェイスの実装

  名前 説明
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .Discover 依存関係を検出します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .GetDomainRoot ドメインのルートを返します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .GetParent このオブジェクトの親を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .GetPropertyType 指定したプロパティの種類を取得します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .GetPropertyValue 指定されたプロパティの値を取得します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .GetUrn オブジェクトの Uniform Resource Name を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .Resolve オブジェクトに関する情報を含むインスタンスを、オブジェクトの Unified Resource Name から取得します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .SetObjectState オブジェクトの状態を、指定した SfcObjectState 値に設定します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject. . :: . .SetPropertyValue プロパティの値を設定します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド ISfcPropertyProvider. . :: . .GetPropertySet このオブジェクトのプロパティ セットへのインターフェイス リファレンスを取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)

先頭に戻る

説明

UserDefinedMessage オブジェクトは、ユーザーによって定義されたメッセージを表します。SystemMessage オブジェクトは、システムによってあらかじめ定義されているメッセージを表します。

UserDefinedMessage オブジェクトのプロパティを取得または設定するには、固定サーバー ロール public のメンバでもかまいません。

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照

その他の技術情報