• Artigo

Classe UserDefinedMessage

The UserDefinedMessage object represents a user-defined message.

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

Sintaxe

'Declaração
Public NotInheritable Class UserDefinedMessage _
    Inherits MessageObjectBase _
    Implements ICreatable, IDroppable, IAlterable, IScriptable
'Uso
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

O tipo UserDefinedMessage expõe os membros a seguir.

Construtores

  Nome Descrição
Método público UserDefinedMessage() () () () Initializes a new instance of the UserDefinedMessage class.
Método público UserDefinedMessage(Server, Int32) Initializes a new instance of the UserDefinedMessage class on the specified instance of SQL Server and with the specified ID value.
Método público 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.
Método público 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.
Método público 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.
Método público 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.
Método público 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.

Início

Propriedades

  Nome Descrição
Propriedade protegida ExecuteForScalar Obtém ou define o valor da propriedade Boolean que especifica se o objeto esta definido para a opção execute for scalar. (Herdado de SqlSmoObject.)
Propriedade pública ID Gets the ID value that uniquely identifies the user-defined message.
Propriedade pública IsLogged Gets or sets the Boolean property value that specifies whether the message is logged to the Microsoft Windows event log.
Propriedade protegida IsTouched Obtém o valor da propriedade Boolean que especifica se as propriedades do objeto foram atualizadas, mas ainda não foram persistidas no servidor. (Herdado de SqlSmoObject.)
Propriedade pública Language Gets or sets the language in which the message is written.
Propriedade pública LanguageID Gets or sets the ID value that uniquely identifies the language in which the message is written.
Propriedade protegida ObjectInSpace Obtém o valor da propriedade Boolean que especifica se o objeto existe em isolamento ou se está direta ou indiretamente conectado com a instância do SQL Server. (Herdado de SqlSmoObject.)
Propriedade pública Parent Gets the Server object that specifies the parent of the UserDefinedMessage object.
Propriedade pública Properties Obtém uma coleção de objetos Property que representam as propriedades do objeto. (Herdado de SqlSmoObject.)
Propriedade protegida ScalarResult Obtém o resultado escalar do objeto referenciado. (Herdado de SqlSmoObject.)
Propriedade pública Severity Gets or sets the severity of the user-defined message.
Propriedade pública State Gets the state of the referenced object. (Herdado de SmoObjectBase.)
Propriedade pública Text Gets or sets the textual description of the user-defined message.
Propriedade pública Urn Obtém o valor do endereço do URN (Uniform Resource Name) que identifica exclusivamente o objeto. (Herdado de SqlSmoObject.)
Propriedade pública UserData Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.)

Início

Métodos

  Nome Descrição
Método protegido AddDatabaseContext(StringCollection) Adiciona o contexto do banco de dados à coleção de consultas identificadas pelo parâmetro queries. (Herdado de SqlSmoObject.)
Método protegido AddDatabaseContext(StringCollection, ScriptingOptions) Adiciona o contexto de banco de dados à coleção de consultas identificadas pelo parâmetro queries e usando as opções de script especificadas. (Herdado de SqlSmoObject.)
Método público Alter Updates any UserDefinedMessage object property changes on the instance of SQL Server. 
Método protegido AlterImpl Ativa o evento alterado do objeto. (Herdado de SqlSmoObject.)
Método protegido AlterImplFinish Método chamado quando o evento alterado do objeto é concluído. (Herdado de SqlSmoObject.)
Método protegido AlterImplInit Método chamado quando o evento de alteração do objeto é inicializado. (Herdado de SqlSmoObject.)
Método protegido AlterImplWorker Chama os métodos Alter. (Herdado de SqlSmoObject.)
Método protegido BindDefaultImpl Associa os itens padrão identificados pelos parâmetros. (Herdado de SqlSmoObject.)
Método protegido BindRuleImpl Associa o esquema de regra à regra e às colunas identificadas pelos parâmetros. (Herdado de SqlSmoObject.)
Método protegido CheckCollation Verifica a ordem das opções de script pelo método de agrupamento identificado pelo parâmetro collationName. (Herdado de SqlSmoObject.)
Método protegido CheckObjectState() () () () Valida o estado do objeto referenciado. (Herdado de SqlSmoObject.)
Método protegido CheckObjectState(Boolean) Valida o estado do objeto referenciado com a opção de especificar que uma exceção será gerada se o objeto ainda não tiver sido criado. (Herdado de SqlSmoObject.)
Método protegido CheckObjectStateImpl Verifica o estado de um SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido CheckVersion100 Verifica se a versão do SQL Server é SQL Server 2008. (Herdado de SqlSmoObject.)
Método protegido CheckVersion80 Verifica a validade do objeto no SQL Server 2000. (Herdado de SqlSmoObject.)
Método protegido CheckVersion80SP3 Verifica a validade do objeto no SQL Server 2000 SP3. (Herdado de SqlSmoObject.)
Método protegido CheckVersion90 Verifica a validade do objeto no SQL Server 2005. (Herdado de SqlSmoObject.)
Método protegido CheckVersionBelow90 Verifica se a versão do SQL Server é anterior ao SQL Server 2005. (Herdado de SqlSmoObject.)
Método protegido CleanObject Define o objeto como estado inalterado. (Herdado de SqlSmoObject.)
Método público Create Creates a user-defined message on the instance of SQL Server as defined by the UserDefinedMessage object.
Método protegido CreateImpl Cria um objeto com as opções do script. (Herdado de SqlSmoObject.)
Método protegido CreateImplFinish Método chamado quando o evento de criação é concluído. (Herdado de SqlSmoObject.)
Método protegido CreateImplInit Método chamado quando o evento de criação é inicializado. (Herdado de SqlSmoObject.)
Método público Discover Descobre uma lista do tipo Object. (Herdado de SqlSmoObject.)
Método público Drop Removes the user-defined message from the instance of SQL Server.
Método protegido DropImpl Remove um SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido DropImplWorker Chama os métodos de remoção. (Herdado de SqlSmoObject.)
Método protegido EnumScriptImpl Enumera scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.)
Método protegido EnumScriptImplWorker Chama os métodos que enumeram scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.)
Método protegido EnumScriptImplWorkerSOChanged Retorna uma cadeia de caracteres IEnumerable que descreve as opções de script de um objeto. (Herdado de SqlSmoObject.)
Método público Equals (Herdado de Object.)
Método protegido ExecuteNonQuery (Herdado de SqlSmoObject.)
Método protegido Finalize (Herdado de Object.)
Método protegido FormatSqlVariant Formata um objeto como tipo SqlVariant. (Herdado de SqlSmoObject.)
Método protegido GenerateDataSpaceFileStreamScript Gera um script para criar arquivo de dados. (Herdado de SqlSmoObject.)
Método protegido GenerateDataSpaceScript Gera um script para alocar espaço no arquivo de dados. (Herdado de SqlSmoObject.)
Método protegido GetBindDefaultScript Obtém o script que associa padrões especificados pelos parâmetros defSchema e defName. (Herdado de SqlSmoObject.)
Método protegido GetBindRuleScript Obtém o script que especifica as regras de associação. (Herdado de SqlSmoObject.)
Método protegido GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Atribui um parâmetro booliano do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Atribui uma propriedade booliana do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetDateTimeParameter Atribui a propriedade datetime do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetDateTimeParameterAsInt Atribuirá a propriedade datetime do SqlSmoObject como um valor inteiro se a propriedade datetime não for nula. (Herdado de SqlSmoObject.)
Método protegido GetDBName Obtém o nome do banco de dados associado ao objeto. (Herdado de SqlSmoObject.)
Método protegido GetEnumParameter Atribui uma propriedade de enumeração do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetFragOptionString Obtém um objeto FragmentationOption como um valor de cadeia de caracteres. (Herdado de SqlSmoObject.)
Método protegido GetGuidParameter Atribui uma propriedade Guid do SqlSmoObject. (Herdado de SqlSmoObject.)
Método público GetHashCode (Herdado de Object.)
Método protegido GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetPropValue Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptional Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetRealValue Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetScriptingOptionsForCreate Obtém ScriptingOptions para o objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetServerName Obtém o nome da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.)
Método protegido GetServerObject Obtém o servidor do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetSqlServerVersionName Obtém o nome da versão da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.)
Método protegido GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetTimeSpanParameterAsInt Atribui um parâmetro de período de tempo do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método público GetType (Herdado de Object.)
Método protegido GetUrnRecursive(StringBuilder) Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetUrnRecursive(StringBuilder, UrnIdOption) Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ImplInitialize Inicializa os campos do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método público Initialize() () () () Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.)
Método público Initialize(Boolean) Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.)
Método protegido IsObjectDirty Verifica se as propriedades de objeto foram modificadas e se as alterações ainda não foram persistidas na instância do SQL Server. (Herdado de SqlSmoObject.)
Método protegido IsObjectInitialized Verifica se o objeto foi inicializado. (Herdado de SqlSmoObject.)
Método protegido IsObjectInSpace Verifica se o objeto está isolado ou conectado com a instância do SQL Server. (Herdado de SqlSmoObject.)
Método protegido IsVersion80SP3 Determina se a versão do SQL Server é SQL Server 2000 com SP3. (Herdado de SqlSmoObject.)
Método protegido IsVersion90AndAbove Determina se a versão do SQL Server é SQL Server 2005 ou posterior. (Herdado de SqlSmoObject.)
Método protegido MarkDropped Define o SqlSmoState como removido. (Herdado de SqlSmoObject.)
Método protegido MarkForDropImpl Define o SqlSmoState como removido. (Herdado de SqlSmoObject.)
Método protegido MemberwiseClone (Herdado de Object.)
Método protegido PostAlter Método ativado depois da alteração do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido PostCreate Método ativado depois da criação do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido PostDrop Método ativado depois da remoção do SqlSmoObject. (Herdado de SqlSmoObject.)
Método público Refresh Atualiza o objeto e recupera as propriedades na próxima vez que o objeto é acessado. (Herdado de SqlSmoObject.)
Método público Script() () () () Generates a Transact-SQL script that can be used to re-create the user-defined message.
Método público Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined message as specified by the script options.
Método protegido ScriptAlter Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.)
Método protegido ScriptCreate Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.)
Método protegido ScriptDdl Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.)
Método protegido ScriptDrop Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.)
Método protegido ScriptImpl() () () () Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ScriptImpl(ScriptingOptions) Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ScriptImplWorker Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido SetParentImpl Define o pai do SqlSmoObject como o parâmetro newParent. (Herdado de SqlSmoObject.)
Método público ToString Retorna um String que representa o objeto referenciado. (Herdado de SqlSmoObject.)
Método protegido TouchImpl Não implementado. (Herdado de SqlSmoObject.)
Método protegido UnbindDefaultImpl Desassocia as colunas padrão do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido UnbindRuleImpl Desassocia as regras do SqlSmoObject. (Herdado de SqlSmoObject.)
Método público Validate Validates the state of an object. (Herdado de SmoObjectBase.)

Início

Eventos

  Nome Descrição
Evento público PropertyChanged Representa o evento que ocorre quando uma propriedade é alterada. (Herdado de SqlSmoObject.)
Evento público PropertyMetadataChanged Representa o evento que ocorre quando os metadados da propriedade são alterados. (Herdado de SqlSmoObject.)

Início

Campos

  Nome Descrição
Campo protegido m_ExtendedProperties Representa uma propriedade definida para estender as propriedades fornecidas por um SqlSmoObject. (Herdado de SqlSmoObject.)
Campo protegido singletonParent Representa o pai do singleton. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .Discover Descobre quaisquer dependências. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetDomainRoot Retorna a raiz do domínio. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetParent Obtém o pai do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetPropertyType Obtém o tipo da propriedade especificada. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetPropertyValue Obtém o valor da propriedade especificada. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetUrn Obtém o Unified Resource Name do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .Resolve Obtém a instância que contém as informações sobre o objeto a partir do Unified Resource Name do objeto. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .SetObjectState Define o estado do objeto como o valor SfcObjectState especificado. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .SetPropertyValue Define o valor da propriedade. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider. . :: . .GetPropertySet Obtém a referência da interface para o conjunto de propriedades deste objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)

Início

Comentários

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.

Exemplos

Usando mensagens

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo

Outros recursos

Usando mensagens